HCL Compass object methods
The following list summarizes the CQCompass object methods:
- Method name
- Description
Build- Creates a CQCompass object.
CreateAdminSession- Creates an AdminSession object.
CreateProductInfo- Creates a CQProductInfo object.
CreateUserSession- Creates a Session object.
GetPerlReturnStringMode- Returns the execution mode for how Strings are returned for Perl hooks and scripts.
GetSessionTimerPollInterval- Returns a value in seconds in which HCL Compass application timer thread polls for idle sessions.
IsUnix- Returns True if the CQCompass object is created on a UNIX™ system or Linux™ platform.
IsWindows- Returns True if the CQCompass object is created in a Windows™ platform.
SessionLogoff- (the UNIX system or Linux only) Logoff a given session.
SessionLogon- (the UNIX system or Linux only) Create and login into a user session.
SetPerlReturnStringMode- Specifies the execution mode for how Strings are returned for Perl hooks and scripts.
SetSessionTimerPollInterval- Specifies a global poll value in seconds in which HCL Compass application timer thread polls for idle sessions.
Unbuild- Deletes the CQCompass object, when you are done with it.