Index

DKLSCfgDefICM

Purpose:

This class provides "getter" and "setter" methods for listing and updating the library server configuration parameters.

Since: Version 8

Class summary:

class DKEXPORT DKLSCfgDefICM
 {
 public :
     DKLSCfgDefICM();
     DKLSCfgDefICM (dkDatastore* ds);
     virtual ~DKLSCfgDefICM();
 
     virtual void setDatastore(dkDatastore* ds);
     virtual dkDatastore* getDatastore();
     virtual DKString datastoreType();
     virtual short getACLBindingLevel();
     virtual void setACLBindingLevel(short sACLBindingLevel);
     virtual long getCurrentUsers();
     virtual void setCurrentUsers(long lCurrentUsers);
     virtual DKString getDatabaseName();
     virtual void setDatabaseName(const char* szDatabaseName);
     virtual DKString getDatabaseSchemaName();
     virtual void setDatabaseSchemaName(const char* szDatabaseName);
     virtual short getDefaultACLChoice();
     virtual void setDefaultACLChoice(short sDfltACLChoice);
     virtual DKString getEncryptionKey();
     virtual void setEncryptionKey(const char* szEncryptionKey);
     virtual DKString getLanguageCode();
     virtual void setLanguageCode(const char* szLanguageCode);
     virtual long getLibraryACLCode();
     virtual void setLibraryACLCode(long lLibraryACLCode);
     virtual DKString getLibraryServerDesc();
     virtual void setLibraryServerDesc(const char* szLibraryServerDesc);
     virtual long getLibraryServerID();
     virtual void setLibraryServerID(long lLibraryServerID);
     virtual DKString getLibraryServerName();
     virtual void setLibraryServerName(const char* szLibraryServerName);
     virtual short getMaxLogonRetry();
     virtual void setMaxLogonRetry(short sMaxLogonRetry);
     virtual short getMaxUserAction();
     virtual void setMaxUserAction(short sMaxUserAction);
     virtual long getMaxUsers();
     virtual void setMaxUsers(long lMaxUsers);
     virtual short getPasswordDuration();
     virtual void setPasswordDuration(short sPasswordDuration);
     virtual short getPublicAccessEnabled();
     virtual void setPublicAccessEnabled(short sPubAccessEnabled);
     virtual short getSMSChoice();
     virtual void setSMSChoice(short sSMSChoice);
     virtual short getSysAdminEventFlag();
     virtual void setSysAdminEventFlag(short sSysAdminEventFlag);
     virtual short getSystemFlag();
     virtual void setSystemFlag(short sSystemFlag);
     virtual long getSystemSegmentThreshold();
     virtual void setSystemSegmentThreshold(long lSysSegmentThreshld);
     virtual short getSystemTraceLevel();
     virtual void setSystemTraceLevel(short sSTTraceLevel);
     virtual DKString getTIEUserID();
     virtual void setTIEUserID(const char* szTIEUserID);
     virtual DKString getTraceFileName();
     virtual void setTraceFileName(const char* szTraceFileName);
     virtual DKBoolean isTIEEnabled();
     virtual DKBoolean isWorkFlowEnabled();
     virtual DKBoolean isIKFEnabled();
     virtual DKBoolean isLDAPEnabled();
     virtual DKBoolean isAdminDomainEnabled();
     virtual void setMaxResultsetSize(long lMaxResultsetSize);
     virtual long getMaxResultsetSize();
     virtual short getDatabaseType();
     virtual void setDatabaseType(short sDatabaseType);
     virtual short getPlatform();
     virtual void setTrustedLogon(short sTrustedLogon);
     virtual short getTrustedLogon();
 } 

Members:

Contructors and Destructor
DKLSCfgDefICM();

Default constructor for the library server configuration object.

DKLSCfgDefICM(dkDatastore * ds);

Constructor that takes a datastore instance as a parameter. Calling this constructor is equivalent to calling the default constructor followed by the setDatastore method. Parameters: ds - datastore object as instance of DKDatastoreICM.

virtual ~DKLSCfgDefICM();

Destructor for this object.

Member functions

datastoreType
Retrieves the type of datastore object associated with this library server configuration object. For Content Manager version 8, this value will be "ICM". Returns: datastore type as a DKString variable.
DKString   datastoreType()

getACLBindingLevel
Retrieves ACL binding level. Returns: ACL binding level. Valid values are:
  • ITEMTYPE_ACL_BINDING
  • ITEM_ACL_BINDING
  • MIXED_ACL_BINDING
  • LIBRARY_ACL_BINDING

short   getACLBindingLevel()

getCurrentUsers
Retrieves the number of current users on the system. Returns: count of number of current users.
long  getCurrentUsers()

getDatabaseName
Retrieves the database name for the library server. Returns: database name as a DKString variable.
DKString  getDatabaseName()

getDatabaseSchemaName
Retrieves the database schema name. Returns: database schema name as a DKString variable.
DKString  getDatabaseSchemaName()

getDatabaseType
Retrieves the database type. Returns: database type.
short getDatabaseType()

getDatastore
Retrieves the datastore object instance for this library server. Returns: database object as an instance of DKDatastoreICM.
dkDatastore* getDatastore()

getDefaultACLChoice
Retrieves the default ACL choice. Returns: default ACL choice.
short  getDefaultACLChoice()

getEncryptionKey
Retrieves the encryption key. Returns: encryption key as a DKString variable.
DKString  getEncryptionKey()

getLanguageCode
Retrieves the language code in use on this library server. Default value is "ENU" (representing US English). Returns: language code as a DKString variable.
DKString getLanguageCode()

getLibraryACLCode
Retrieves the ACL code for this library server. Returns: ACL code.
long  getLibraryACLCode()

getLibraryServerDesc
Retrieves the value of the description for this library server. Returns: library server description as a DKString variable.
DKString  getLibraryServerDesc()

getLibraryServerID
Retrieves the identifier for this library server. Returns: identifier for this library server.
long  getLibraryServerID()

getLibraryServerName
Retrieves the name for this library server. Returns: name as a DKString variable.
DKString  getLibraryServerName()

getMaxLogonRetry
Retrieves the maximum number of times logon attempts to this library server will be retried before the attempt is aborted. Returns: maximum number of logon retry attempts.
short  getMaxLogonRetry()

getMaxResultsetSize
Retrieves the maximum result set size supported on this library server. Returns: maximum result set size in number of rows.
long  getMaxResultsetSize()

getMaxUserAction
Gets Max user action. Returns: maximum user action.
short  getMaxUserAction()

getMaxUsers
Retrieves the maximum number of users supported on this library server. Returns: maximum number of users allowed.
long getMaxUsers()

getPasswordDuration
Retrieves the maximum time for which a user's password is allowed to exist on the system before it must be changed (password expiration). Returns: time duration before password expiration.
short  getPasswordDuration()

getPlatform
Retrieves value for the platform that the library server is running on. Returns: platform identifier. Possible values for this are:
  • DK_CM_PLATFORM_WINDOWS
  • DK_CM_PLATFORM_AIX
  • DK_CM_PLATFORM_SUN
  • DK_CM_PLATFORM_390

short  getPlatform()

getPublicAccessEnabled
Retrieves Public Access Enabled. Returns: Public Access Enabled.
short  getPublicAccessEnabled()

getSMSChoice
Retrieves SMS Choice. Returns: sms choice. Valid values are:
  • SMS_USER_USER - Uses the defaults associated with the user for both the collection name and the object server.
  • SMS_ITEMTYPE_ITEMTYPE - Uses the defaults associated with the item type for both the collection name and the object server.
  • SMS_ITEMTYPE_USER - Uses the defaults associated with the item type for the collection name and defaults associated with the user for the object server.
  • SMS_USER_ITEMTYPE - Uses the defaults associated with the user for the collection name and defaults associated with the item type for the object server.

short  getSMSChoice()

getSysAdminEventFlag
Retrieves the sys admin event flag. Returns: sys admin event flag.
short getSysAdminEventFlag()

getSystemFlag
Retrieves the system flag. Returns: system flag.
short getSystemFlag()

getSystemSegmentThreshold
Retrieves System Segment Threshold. Returns: System segment threshold.
long getSystemSegmentThreshold()

getSystemTraceLevel
Retrieves the system trace level. Returns: system trace level.
short getSystemTraceLevel()

getTIEUserID
Retrieves TIE User ID. Returns: TIE user id as a DKString variable.
DKString getTIEUserID()

getTIEUserPassword
Retrieves TIE User password. Returns: TIE user password as a DKString variable.
virtual DKString getTIEUserID()

getTraceFileName
Retrieves the file name to which tracing entries are being written for this library server. Returns: trace file name as a DKString variable.
DKString getTraceFileName()

getTrustedLogon
Retrieves TrustedLogon Returns: trusted logon.
short getTrustedLogon()

isAdminDomainEnabled
Returns a boolean value indicating whether the administration domain is enabled. Returns: TRUE if administration domain is enabled; FALSE otherwise.
DKBoolean isAdminDomainEnabled()

isIKFEnabled
Returns a boolean value indicating whether LDAP support is enabled on this library server. Returns: TRUE if LDAP is enabled; FALSE otherwise.
DKBoolean isIKFEnabled()

isLDAPEnabled
Returns LDAP enabled state.
DKBoolean isLDAPEnabled()

isTIEEnabled
Returns a boolean value indicating whether the Text Information Extender (TIE) support is enabled on this library server. Returns:TRUE if TIE support is enabled; FALSE otherwise.
DKBoolean isTIEEnabled()

setACLBindingLevel
Sets the ACL binding level for this library server. Parameters: sACLBindingLevel - value to set ACL binding level to. Valid values are:
  • ITEMTYPE_ACL_BINDING
  • ITEM_ACL_BINDING
  • MIXED_ACL_BINDING
  • LIBRARY_ACL_BINDING

void setACLBindingLevel(short sACLBindingLevel)

setCurrentUsers
Sets the maximum number of current users for this library server. Parameters: lCurrentUsers - value for maximum number of current users.
void setCurrentUsers(long lCurrentUsers)

setDatabaseName
Sets the database name for this library server. Parameters: szDatabaseName - value to set database name to.
void setDatabaseName(const char* szDatabaseName)

setDatabaseSchemaName
Sets the database schema name for this library server. Parameters: szDatabaseSchemaName - value to set database schema name to.
void setDatabaseSchemaName(const char* szDatabaseSchemaName)

setDatabaseType
Sets the database type for this library server. Parameters: sDatabaseType - value to set database type to.
void setDatabaseType(short sDatabaseType)

setDatastore
Sets the datastore object associated with this library server configuration object. Parameters: ds - datastore object as instance of DKDatastoreICM.
void setDatastore(dkDatastore* ds)

setDefaultACLChoice
Sets Default ACL Choice. Parameters: sDatabaseType - value to set database type to.
void setDefaultACLChoice(short sDfltACLChoice)

setEncryptionKey
Sets the encryption key for this library server. Parameters: szEncryptionKey - value for encryption key.
void setEncryptionKey(const char* szEncryptionKey)

setLanguageCode
Sets the language code on this library server. Parameters: szLanguageCode - value for the language code (e.g. "ENU" for US English).
void setLanguageCode(const char* szLanguageCode)

setLibraryACLCode
Sets the library ACL code. Parameters: lLibraryACLCode - value to set library ACL code to.
oid setLibraryACLCode(long lLibraryACLCode)

setLibraryServerDesc
Sets the description for this library server. Parameters: szLibraryServerDesc - value to set description to.
void setLibraryServerDesc(const char* szLibraryServerDesc)

setLibraryServerID
Sets the library server identifier. Parameters: lLibraryServerId - value to set the library server identifier to.
void setLibraryServerID(long lLibraryServerID)

setLibraryServerName
Sets the name for this library server. Parameters:szLibraryServerName - value to set library server name to.
void setLibraryServerName(const char* szLibraryServerName)

setMaxLogonRetry
Sets the time duration for the maximum period of time for which logon retry attempts will be made before the logon attempt fails. Parameters: sMaxLogonRetry - value to set maximum logon retry duration to.
void setMaxLogonRetry(short sMaxLogonRetry)

setMaxResultsetSize
Sets the size of the maximum result set on this library server (in number of rows). Parameters: lMaxResultsetSize - size of maximum allowed result set on this library server.
void setMaxResultsetSize(long lMaxResultsetSize)

setMaxUserAction
Sets Max user action. Parameters: sMaxUserAction - new sMaxUserAction value to be set.
void setMaxUsers(long lMaxUsers)

setMaxUsers
Sets the maximum number of users allowed on this library server. Parameters: lMaxUsers - value to set maximum number of allowed users to.
void setMaxUsers(long lMaxUsers)

setPasswordDuration
Sets Password Duration. Parameters: sPasswordDuration - new sPasswordDuration value to be set.
void setPasswordDuration(short sPasswordDuration)

setPublicAccessEnabled
Sets Public Access Enabled. Parameters: sPubAccessEnabled - new sPubAccessEnabled value to be set
void setPublicAccessEnabled(short sPubAccessEnabled)

setSMSChoice
Sets SMS Choice. When a value is not provided for both the object server and the collection name, SMS choice indicates which default values to use for these parameters when creating an item part. Parameters: sPubAccessEnabled - new sPubAccessEnabled value to be set. Valid values are:
  • SMS_USER_USER - Uses the defaults associated with the user for both the collection name and the object server.
  • SMS_ITEMTYPE_ITEMTYPE - Uses the defaults associated with the item type for both the collection name and the object server.
  • SMS_ITEMTYPE_USER - Uses the defaults associated with the item type for the collection name and defaults associated with the user for the object server.
  • SMS_USER_ITEMTYPE - Uses the defaults associated with the user for the collection name and defaults associated with the item type for the object server.

void setSMSChoice(short sSMSChoice)

setSysAdminEventFlag
Sets System Admin Event Flag. Parameters: sSysAdminEventFlag - new sSysAdminEventFlag value to be set.
void setSysAdminEventFlag(short sSysAdminEventFlag)

setSystemFlag
Sets System Flag. Parameters: sSystemFlag - new sSystemFlag value to be set.
void setSystemFlag(short sSystemFlag)

setSystemSegmentThreshold
Sets System Segment Threshold. Parameters: lSysSegmentThreshld - new lSysSegmentThreshld value to be set.
void setSystemSegmentThreshold(long lSysSegmentThreshld)

setSystemTraceLevel
Sets System Trace Level. Parameters: sSTTraceLevel - new sSTTraceLevel value to be set.
void setSystemTraceLevel(short sSTTraceLevel)

setTIEUserID
Sets TIE User ID. Parameters: szTIEUserID - new szTIEUserID value to be set.
void setTIEUserID(const char* szTIEUserID)

setTIEUserPassword
Sets TIE user password. Parameters: szTIEUserPassword - new szTIEUserPassword value to be set
void setTIEUserID(const char* szTIEUserID)

setTraceFileName
Sets Trace File Name. Parameters: szTraceFileName - new szTraceFileName value to be set.
void setTraceFileName(const char* szTraceFileName)

setTrustedLogon
Sets TrustedLogon. Parameters: sTrustedLogon - new sTrustedLogon value to be set.
void setTrustedLogon(short sTrustedLogon)

(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.