Package Thor.API.Operations

Interface tcHelpOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface tcHelpOperationsIntf
extends tcUtilityOperationsIntf

Method Summary

Modifier and Type	Method	Description
Map	getHelpAbout()	This method returns the about information of Xellerate
String	getSortValue()	This method returns the value of the NLS_SORT database parameter in case of installations with Oracle as the database.

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Details

getHelpAbout

Map getHelpAbout()
          throws tcAPIException,
tcAPIException

This method returns the about information of Xellerate

Returns:

a map instance with the following keys:

• Version
• Build
• User
• Database
• Database Build

The names (map keys) are case sensitive and start with uppercase character.

Throws:

tcAPIException

Since:

8.0

getSortValue

String getSortValue()
             throws tcAPIException,
tcAPIException

This method returns the value of the NLS_SORT database parameter in case of installations with Oracle as the database. In case of SQL Server, this method returns a null. The method reads then caches the value of NLS_SORT from an Oracle session. The method assumes that all sessions have set the same value for NLS_SORT.

Returns:

String specifying the value of the NLS_SORT database parameter

Throws:

tcAPIException

Since:

9.0