Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAdminDomainDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractAdminDomainDef
        |
        +--com.ibm.mm.sdk.common.DKAdminDomainDefICM
All Implemented Interfaces:
dkAdminDomainDef, DKMessageId, java.io.Serializable

public class DKAdminDomainDefICM
extends dkAbstractAdminDomainDef
implements java.io.Serializable

The DKAdminDomainDefICM class is the implementation of the abstract class dkAdminDomainDef. Use this class to represent an administration domain in your program. This class provides facilities to manage administration domain related entities such as Users, User Groups, ACLs, Privilege Sets, Resource Managers and SMS Collections.

See Also:
, Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKAdminDomainDefICM()
          Default constructor Constructs an administrative domain object.
DKAdminDomainDefICM(dkDatastore ds)
          Constructs an administrative domain object and initializes it with the datastore.
 
Method Summary
 java.lang.String[] getACLNames()
          Gets a list of ACL names in this administrative domain
 java.lang.String[] getPrivSetNames()
          Gets a list of privilege set names in this administrative domain
 java.lang.String[] getResourceMgrNames()
          Gets a list of resource manager names in this administrative domain.
 java.lang.String[] getSMSCollectionNames()
          Gets a list of SMS collection names in this administrative domain
 java.lang.String[] getUserGroupNames()
          Gets a list of user group names in this administrative domain.
 java.lang.String[] getUserNames()
          Gets a list of user names in this administrative domain
 void setACLNames(java.lang.String[] s)
          Sets a list of ACL names to this administrative domain.
 void setPrivSetNames(java.lang.String[] s)
          Sets a list of privilege set names to this administrative domain.
 void setResourceMgrNames(java.lang.String[] s)
          Sets a list of resource manager names to this administrative domain.
 void setSMSCollectionNames(java.lang.String[] s)
          Sets a list of SMS collection names to this administrative domain.
 void setUserGroupNames(java.lang.String[] s)
          Sets a list of user group names to this administrative domain.
 void setUserNames(java.lang.String[] s)
          Sets a list of user names to this administrative domain.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractAdminDomainDef
getDatastore, getDescription, getID, getName, getNLSLanguage, setDatastore, setDescription, setID, setName, setNLSLanguage
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKAdminDomainDefICM

public DKAdminDomainDefICM()
Default constructor Constructs an administrative domain object. The datastore should be initialized before using this object in DKAdminDomainsMgmtICM class operations. The setDatastore() method can be used to set the datastore.
  DKAdminDomainDefICM admDomain = new DKAdminDomainDefICM();  
  admDomain.setDatastore(ds);
  

DKAdminDomainDefICM

public DKAdminDomainDefICM(dkDatastore ds)
Constructs an administrative domain object and initializes it with the datastore.
Parameters:
ds - - A reference to a datasore object to which this administration domain object belongs to
Method Detail

getUserNames

public java.lang.String[] getUserNames()
                                throws DKException,
                                       java.lang.Exception
Gets a list of user names in this administrative domain
Overrides:
getUserNames in class dkAbstractAdminDomainDef
Returns:
a list of the user names. A null is returned if no users are in this administrative domain.
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

setUserNames

public void setUserNames(java.lang.String[] s)
                  throws DKException,
                         java.lang.Exception
Sets a list of user names to this administrative domain. A copy of the string array is stored
Overrides:
setUserNames in class dkAbstractAdminDomainDef
Parameters:
s - list of user names.
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

getUserGroupNames

public java.lang.String[] getUserGroupNames()
                                     throws DKException,
                                            java.lang.Exception
Gets a list of user group names in this administrative domain.
Overrides:
getUserGroupNames in class dkAbstractAdminDomainDef
Returns:
a list of the user group names. A null is returned if no user groups are in this administrative domain.
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

setUserGroupNames

public void setUserGroupNames(java.lang.String[] s)
                       throws DKException,
                              java.lang.Exception
Sets a list of user group names to this administrative domain. A copy of the string array is stored.
Overrides:
setUserGroupNames in class dkAbstractAdminDomainDef
Parameters:
s - list of user group names
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

getPrivSetNames

public java.lang.String[] getPrivSetNames()
                                   throws DKException,
                                          java.lang.Exception
Gets a list of privilege set names in this administrative domain
Overrides:
getPrivSetNames in class dkAbstractAdminDomainDef
Returns:
a list of the privilege set names. A null is returned if no privilege sets are in this administrative domain.
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

setPrivSetNames

public void setPrivSetNames(java.lang.String[] s)
                     throws DKException,
                            java.lang.Exception
Sets a list of privilege set names to this administrative domain. A copy of the string array is stored.
Overrides:
setPrivSetNames in class dkAbstractAdminDomainDef
Parameters:
s - list of privilege set names
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

getACLNames

public java.lang.String[] getACLNames()
                               throws DKException,
                                      java.lang.Exception
Gets a list of ACL names in this administrative domain
Overrides:
getACLNames in class dkAbstractAdminDomainDef
Returns:
a list of the ACL names. A null is returned if no ACLs are in this administrative domain.
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

setACLNames

public void setACLNames(java.lang.String[] s)
                 throws DKException,
                        java.lang.Exception
Sets a list of ACL names to this administrative domain. A copy of the string array is stored.
Overrides:
setACLNames in class dkAbstractAdminDomainDef
Parameters:
s - list of ACL names
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

getResourceMgrNames

public java.lang.String[] getResourceMgrNames()
                                       throws DKException,
                                              java.lang.Exception
Gets a list of resource manager names in this administrative domain.
Overrides:
getResourceMgrNames in class dkAbstractAdminDomainDef
Returns:
a list of the resource manager names. A null is returned if no Resource Managers are in this administrative domain.
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

setResourceMgrNames

public void setResourceMgrNames(java.lang.String[] s)
                         throws DKException,
                                java.lang.Exception
Sets a list of resource manager names to this administrative domain. A copy of the string array is stored.
Overrides:
setResourceMgrNames in class dkAbstractAdminDomainDef
Parameters:
s - list of resource manager names.
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

getSMSCollectionNames

public java.lang.String[] getSMSCollectionNames()
                                         throws DKException,
                                                java.lang.Exception
Gets a list of SMS collection names in this administrative domain
Overrides:
getSMSCollectionNames in class dkAbstractAdminDomainDef
Returns:
a list of the SMS collection names. A null is returned if no SMS Collections are in this administrative domain.
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

setSMSCollectionNames

public void setSMSCollectionNames(java.lang.String[] s)
                           throws DKException,
                                  java.lang.Exception
Sets a list of SMS collection names to this administrative domain. A copy of the string array is stored.
Overrides:
setSMSCollectionNames in class dkAbstractAdminDomainDef
Parameters:
s - list of SMS collection names.
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

EIP Java APIs

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