AdminSession object methods

The following list summarizes the AdminSession object methods:

Note: For all Perl Get and Set methods that map to Visual Basic Properties, see the Properties section of this object.
Method name
Description
Build
(Perl only) Creates an AdminSession object.
CQDataCodePageIsSet
Returns whether the HCL Compass data code page has been set, or not.
CreateDatabase
Creates a new database and associates it with the schema repository.
CreateGroup
Creates a new group and associates it with the schema repository.
CreateUser
Creates a new user and associates it with the schema repository.
CreateUserLDAPAuthenticated
Creates a HCL Compass user account with LDAP authentication.
DeleteDatabase
Disassociates the specified database from the schema repository.
GetAuthenticationAlgorithm
Returns the authentication algorithm of the schema repository.
GetAuthenticationLoginName
Returns the login name (that is, the user name) that a user enters as the login name when authenticating.
GetClientCodePage
Returns a String describing the client's code page.
GetCQDataCodePage
Returns a String describing the HCL Compass data code page.
GetCQLDAPMap
Returns the HCL Compass user profile field that is used for correlating LDAP user records to HCL Compass user records.
GetDatabase
Returns the database object with the specified name.
GetEveryoneGroupName
Returns the Everyone group name.
GetGroup
Returns the group object with the specified name.
GetLastSchemaRepoInfo
Returns schema repository information for the current connection.
GetLastSchemaRepoInfoByDbSet
Returns schema repository information for the current connection, given a database set name.
GetLocalReplicaName
Returns the name of the local replica.
GetReplicaNames
Returns a reference to the replica names.
GetUser
Returns the user object with the specified name.
GetUserLoginName
Returns the HCL Compass user name stored in the database and required for most HCL Compass functions, such as queries.
IsClientCodePageCompatibleWithCQDataCodePage
Returns whether the client code page is compatible with the HCL Compass data code page, or not.
IsMultisiteActivated
Returns a boolean indicating whether the current database has been activated for multisite operations.
IsReplicated
Returns a boolean indicating whether the current database has at lease two replicated sites.
IsSiteWorkingMaster
Enables you to determine whether or not a database is a working master site.
IsStringInCQDataCodePage
Returns whether, or not, the HCL Compass data code page contains a given String.
IsUnsupportedClientCodePage
Returns whether the client code page is unsupported, or not.
IsValidName
Validates whether the name is valid for the given type.
Logon
Logs the specified user into the schema repository.
RegisterSchemaRepoFromFile
Creates a new database set, given a file path.
RegisterSchemaRepoFromFileByDbSet
Creates a new database set, given a database set name.
SetAuthenticationAlgorithm
Sets the authentication algorithm for the schema repository.
Unbuild
(Perl only) Deletes an AdminSession object, when you are done with it.
ValidateStringInCQDataCodePage
Checks to see if a given String is in the HCL Compass data code page for the session's schema-repository.
ValidateUserCredentials
Validates the user credentials, given a login name and password.

Additional Perl Get and Set Methods that map to Visual Basic properties:

Method name
Description
GetDatabases
Returns the collection of databases associated with the schema repository.
GetGroups
Returns the collection of groups associated with the schema repository.
GetSchemas
Returns the collection of schemas associated with the schema repository.
GetUsers
Returns the collection of users associated with the schema repository.