AdminSession object methods
The following list summarizes the AdminSession object methods:
- Method name
- Description
- Build
- Creates an AdminSession object.
- CQDataCodePageIsSet
- Returns whether the DevOps Plan 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 DevOps Plan 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 application's code page.
- GetCQDataCodePage
- Returns a String describing the DevOps Plan data code page.
- GetCQLDAPMap
- Returns the DevOps Plan user profile field that is used for correlating LDAP user records to DevOps Plan 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.
- 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 DevOps Plan user name stored in the database and required for most DevOps Plan functions, such as queries.
- IsClientCodePageCompatibleWithCQDataCodePage
- Returns whether the application code page is compatible with the DevOps Plan 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 DevOps Plan data code page contains a given String.
- IsUnsupportedClientCodePage
- Returns whether the application 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 DevOps Plan data code page for the session's schema-repository.
- ValidateUserCredentials
- Validates the user credentials, given a login name and password.