The following list summarizes the Session object
methods:
- Method name
- Description
- AddListMember
- Adds a list member to the named list.
- Build
- (Perl only) Creates a Session object.
- BuildEntity
- Creates a new record of the specified type and
begins a Submit action.
- BuildPermission
- Builds and returns a Permission object.
- BuildPermissions
- Builds and returns a Permissions object.
- BuildQuery
- Creates and returns a new QueryDef object for the
specified record type.
- BuildResultSet
- Creates and returns a result set that can be used
to run a query.
- BuildSQLQuery
- Creates and returns a ResultSet object using a
raw SQL string.
- CanSubmit
- Returns True if the current user is allowed to
submit the named record type.
- CQDataCodePageIsSet
- Returns whether the Rational® ClearQuest® data code page has been set,
or not.
- ClearNameValues
- Clears all name values for the current session.
- DbIdToStringId
- Returns the IDid string translated from dbid.
- DeleteEntity
- Deletes the specified record from the current database.
- DeleteListMember
- Deletes a member from a named list.
- EditEntity
- Performs the specified action on a record and makes
the record available for editing.
- EntityVisible
- Returns an indication of whether the entity exists and is hidden
or not.
- EntityVisibleByDbId
- Returns an indication of whether the entity exists and is hidden
or not.
- FireRecordScriptAlias
- Calls the action that calls the hook script; use
to simulate a user choosing an action that launches a hook.
- GetAccessibleDatabases
- Returns a list of databases that are available
for the specified user to log in to.
- GetAllGroups
- Returns the names of all the groups the current user can view.
- GetAllUsers
- Returns the names of all the users the current user can view.
- GetAuthenticationLoginName
- Returns the login name (that is, the user name)
that a user enters as the login name when authenticating.
- GetAuxEntityDefNames
- Returns an array of strings, each of which corresponds
to the name of one of the schema stateless record types.
- GetBasicReturnStringMode
- Returns the execution mode for how Strings are
returned for VBScript hooks and scripts.
- GetBuildNumber
- Returns the product build number.
- GetClearQuestAPIVersionMajor
- Returns a version number for the API itself.
- GetClearQuestAPIVersionMinor
- Returns a version number for the API itself.
- GetClientCodePage
- Returns a String describing the client's code page.
- GetCompanyEmailAddress
- Returns the company e-mail address of the company for the current
locale.
- GetCompanyFullName
- Returns the full name of the company in the current locale.
- GetCompanyName
- Returns the name of the company in the current locale.
- GetCompanyWebAddress
- Returns the web address of the company for the current locale.
- GetCQDataCodePage
- Returns a String describing the Rational ClearQuest data code page.
- GetDefaultDbSetName
- Returns the default database set name.
- GetDefaultEntityDef
- Returns the schema's default EntityDef object.
- GetDisplayNamesNeedingSiteExtension
- Gets the names of objects needing a site extension.
- GetEnabledEntityDefs
- Returns the EntityDefs collection object enabled
in the current schema for a given package revision.
- GetEnabledPackageRevs
- Returns a collection object representing the PackageRev
set that is enabled for the current revision of the schema.
- GetEntity
- Returns the specified record.
- GetEntityByDbId
- Returns the record with the specified database
ID.
- GetEntityDef
- Returns the specified EntityDef object.
- GetEntityDefFamilyName
- Returns the requested EntityDef object if it is
a family.
- GetEntityDefFamilyNames
- Returns an array containing the requested EntityDef
family names.
- GetEntityDefNames
- Returns an array containing the names of the record
types in the current database's schema.
- GetEntityDefNamesForSubmit
- Returns the list of all record types the user is
allowed to submit.
- GetEntityDefOfDbId
- Provides ‘Find Record’ functionality. Returns the EntitiyDef object
for the given record database ID (DBID).
- GetEntityDefOfName
- Provides ‘Find Record’ functionality. Returns the EntitiyDef object
for the given record display name.
- GetEntityDefOrFamily
- Returns the named EntityDef object.
- GetEveryoneGroupName
- Returns the Everyone group name.
- GetFullProductVersion
- Returns the full product version string.
- GetHookSeesAllRecords
- Indicates whether the current hook sees all records or only the
records that the current user is allowed to see.
- GetHookSeesAllUsers
- Indicates whether the current hook sees all users or only the
users that the current user is allowed to see.
- GetInstalledDbSets
- Returns the list of registered database sets.
- GetInstalledMasterDbs
- Returns the list of registered schema repositories
(master databases).
- GetInstalledMasters
- Returns the list of registered database sets and
schema repositories (master databases).
- GetLicenseFeature
- Returns the FLEXlm feature name used to get a license.
- GetLicenseVersion
- Returns the version of the FLEXlm feature that is used to get
a license.
- GetListDefNames
- Returns a list of the dynamic lists in the current
database.
- GetListMembers
- Returns the choice values of a dynamic list.
- GetLocalReplica
- Returns information about database replication.
- GetMaxCompatibleFeatureLevel
- Gets the maximum database version number supported
by the Rational ClearQuest client
running on this machine.
- GetMinCompatibleFeatureLevel
- Gets the minimum database version number supported
by the Rational ClearQuest client
running on this machine.
- GetPatchVersion
- Returns the current fix pack version of the product.
- GetProductInfo
- (Perl only) Returns a CQProductInfo object.
- GetProductVersion
- Returns the internal product version string that
is hard-coded in header file.
- GetQueryEntityDefFamilyNames
- Returns the names of all family query EntityDefs.
- GetQueryEntityDefNames
- Returns the names of the record types that are
suitable for use in queries.
- GetReqEntityDefNames
- Returns the names of the state-based record types
in the current database's schema.
- GetServerInfo
- Returns a String identifying the session's OLE
server.
- GetSessionDatabase
- Returns general information about the database
that is being accessed in the current session.
- GetSessionFeatureLevel
- Gets the version number of the Rational ClearQuest client
currently running on this machine.
- GetSiteExtendedNames
- Gets extended names of database objects.
- GetSiteExtension
- Gets site extension for a database.
- GetStageLabel
- Returns stage label used for the build; the stage
label is dynamically generated for each build.
- GetSubmitEntityDefNames
- Returns an array containing the names of the record
types that are suitable for use in creating a new record.
- GetSuiteProductVersion
- Returns the suite version string.
- GetSuiteVersion
- Returns the suite version string.
- GetUnextendedName
- Gets the unextended name of a database.
- GetUserEmail
- Returns the electronic mail address of the user
who is logged in for this session.
- GetUserFullName
- Returns the full name of the user who is logged
in for this session.
- GetUserGroups
- Returns a list of the groups to which the current
user belongs.
- GetUserLoginName
- Returns the name that was used to log in for this
session.
- GetUserMiscInfo
- Returns miscellaneous information about the user
who is logged in for this session.
- GetUserPhone
- Returns the telephone number of the user who is
logged in for this session.
- GetWebLicenseVersion
- Returns the version of the FLEXlm feature that is used to get
a web license.
- GetWorkSpace
- Returns the session's Workspace object.
- HasUserPrivilege
- Tests a user privilege level in a security context.
- HasValue
- Returns a Bool indicating whether the specified
session variable exists.
- IsClientCodePageCompatibleWithCQDataCodePage
- Returns whether the client code page is compatible
with the Rational ClearQuest data
code page, or not.
- IsEmailEnabled
- Tests whether the current user has e-mail enabled or not.
- IsMetadataReadonly
- Returns a boolean indicating whether the session's
metadata is read-only.
- IsMultisiteActivated
- Returns a boolean indicating whether the current
database has been activated for multisite operations.
- IsPackageUpgradeNeeded
- Returns a boolean indicating whether the current
revision of package that is applied to the schema is the highest package
revision that is available for the package.
- IsReplicated
- Returns a boolean indicating whether the current
database has at lease two replicated sites.
- IsRestrictedUser
- Tests whether the current user is operating under
the restricted mode capabilities of the ClearQuest Web client.
- IsSiteExtendedName
- Tests whether a database name is an extended name.
- IsStringInCQDataCodePage
- Returns whether, the Rational ClearQuest data
code page contains a given String.
- IsUnix
- Returns a Boolean indicating whether Rational ClearQuest is
running on the UNIX system or Linux machine.
- IsUnsupportedClientCodePage
- Returns whether the client code page is unsupported,
or not.
- IsUserAppBuilder
- Tests schema designer privileges in a security
context.
- IsUserSuperUser
- Tests super user privileges in a security context.
- IsWindows
- Returns a Boolean indicating whether IBM Rational ClearQuest is
running on a Windows machine.
- LoadEntity
- Gets latest values of a record.
- LoadEntityByDbId
- Gets latest values of a record.
- MarkEntityAsDuplicate
- Modifies the specified record to indicate that
it is a duplicate of another record.
- OpenQueryDef
- Loads a query from a file.
- OutputDebugString
- Specifies a message that can be displayed by a
debugger or a similar tool.
- ParseSiteExtendedName
- Splits a database name into an unextended name
and a site extension.
- SetBasicReturnStringMode
- Specifies the execution mode for how Strings are
returned for VBScript hooks and scripts.
- SetHookSeesAllRecords
- Specifies whether the current hook sees all records or only the
records that the current user is allowed to see.
- SetHookSeesAllUsers
- Specifies whether the current hook sees all users or only the
users that the current user is allowed to see.
- SetListMembers
- Sets the members in a named list.
- StringIdToDbId
- Returns the dbid number translated from string
id.
- Unbuild
- (Perl only) Deletes a Session object, when you
are done with it.
- UnmarkEntityAsDuplicate
- Removes the indication that the specified record
is a duplicate of another record.
- UserLogon
- Log in as the specified user for a database session.
- ValidateStringInCQDataCodePage
- Checks to see if a given String is in the Rational ClearQuest data
code page for the session's schema-repository.
- ValidateUserCredentials
- Validates the user credentials, given a login
name and password.
Note: For Perl methods that map to Visual
Basic Properties, see the Properties section of this object.
The following list summarizes additional Perl Session
object methods:
- Method name
- Description
- Get NameValue
- Gets the value associated with a given variable
name.
- Set NameValue
- Sets the value associated with a given variable
name.