Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkAbstractAdminDomainDef

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

public abstract class dkAbstractAdminDomainDef
extends java.lang.Object
implements dkAdminDomainDef, DKMessageId, java.io.Serializable

The dkAbstractAdminDomainDef class represents an administrative domain object.

See Also:
dkAdminDomainDef, Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
dkAbstractAdminDomainDef()
          Default constructor Constructs an administrative domain object.
dkAbstractAdminDomainDef(dkDatastore ds)
          Constructs an administrative domain object and initializes it with the datastore.
 
Method Summary
 java.lang.String[] getACLNames()
          Gets a list of ACLs defined to this admin domain
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getDescription()
          gets the description of this admin domain
 int getID()
          gets the ID of this admin domain
 java.lang.String getName()
          Gets admin domain name
 java.lang.String getNLSLanguage()
          gets the NLS language of this admin domain
 java.lang.String[] getPrivSetNames()
          Gets a list of privilege sets defined to this admin domain
 java.lang.String[] getResourceMgrNames()
          Gets a list of Resource Managers defined to this admin domain
 java.lang.String[] getSMSCollectionNames()
          Gets a list of collections defined to this admin domain
 java.lang.String[] getUserGroupNames()
          Gets a list of user groups defined to this admin domain
 java.lang.String[] getUserNames()
          Gets a list of users defined to this admin domain
 void setACLNames(java.lang.String[] s)
          Sets a list of ACLs to this admin domain
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setDescription(java.lang.String description)
          sets the description of this admin domain
 void setID(int id)
          sets the ID of this admin domain
 void setName(java.lang.String name)
          Sets the admin domain name
 void setNLSLanguage(java.lang.String langCode)
          sets the NLS language for this admin domain
 void setPrivSetNames(java.lang.String[] s)
          Sets a list of privilege sets to this admin domain
 void setResourceMgrNames(java.lang.String[] s)
          Sets a list of Resource Managers to this admin domain
 void setSMSCollectionNames(java.lang.String[] s)
          Sets a list of collections to this admin domain
 void setUserGroupNames(java.lang.String[] s)
          Sets a list of user groups to this admin domain
 void setUserNames(java.lang.String[] s)
          Sets a list of users to this admin domain
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

dkAbstractAdminDomainDef

public dkAbstractAdminDomainDef()
Default constructor Constructs an administrative domain object.

dkAbstractAdminDomainDef

public dkAbstractAdminDomainDef(dkDatastore ds)
Constructs an administrative domain object and initializes it with the datastore.
Parameters:
ds - dkDatastore reference
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Specified by:
setDatastore in interface dkAdminDomainDef
Parameters:
ds - datastore object

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Specified by:
getDatastore in interface dkAdminDomainDef
Returns:
the dkDatastore object

setName

public void setName(java.lang.String name)
Sets the admin domain name
Specified by:
setName in interface dkAdminDomainDef
Parameters:
name - -- new name to be set to this admin domain

getName

public java.lang.String getName()
Gets admin domain name
Specified by:
getName in interface dkAdminDomainDef
Returns:
name of this admin domain

setDescription

public void setDescription(java.lang.String description)
sets the description of this admin domain
Specified by:
setDescription in interface dkAdminDomainDef
Parameters:
description - admin domain description

getDescription

public java.lang.String getDescription()
gets the description of this admin domain
Specified by:
getDescription in interface dkAdminDomainDef
Returns:
the admin domain description

setID

public void setID(int id)
sets the ID of this admin domain
Specified by:
setID in interface dkAdminDomainDef
Parameters:
id - - the admin domain id

getID

public int getID()
gets the ID of this admin domain
Specified by:
getID in interface dkAdminDomainDef
Returns:
the admin domain id

setNLSLanguage

public void setNLSLanguage(java.lang.String langCode)
sets the NLS language for this admin domain
Specified by:
setNLSLanguage in interface dkAdminDomainDef
Parameters:
langCode - the NLS language for the domain

getNLSLanguage

public java.lang.String getNLSLanguage()
gets the NLS language of this admin domain
Specified by:
getNLSLanguage in interface dkAdminDomainDef
Returns:
the NLS language for the domain

getUserNames

public java.lang.String[] getUserNames()
                                throws DKException,
                                       java.lang.Exception
Gets a list of users defined to this admin domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
getUserNames in interface dkAdminDomainDef
Returns:
a list of user names
Throws:
DKException - if error occurs

setUserNames

public void setUserNames(java.lang.String[] s)
                  throws DKException,
                         java.lang.Exception
Sets a list of users to this admin domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
setUserNames in interface dkAdminDomainDef
Parameters:
s - list of user names
Throws:
DKException - if error occurs

getUserGroupNames

public java.lang.String[] getUserGroupNames()
                                     throws DKException,
                                            java.lang.Exception
Gets a list of user groups defined to this admin domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
getUserGroupNames in interface dkAdminDomainDef
Returns:
a list of user group names
Throws:
DKException - if error occurs

setUserGroupNames

public void setUserGroupNames(java.lang.String[] s)
                       throws DKException,
                              java.lang.Exception
Sets a list of user groups to this admin domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
setUserGroupNames in interface dkAdminDomainDef
Parameters:
s - list of user group names
Throws:
DKException - if error occurs

getPrivSetNames

public java.lang.String[] getPrivSetNames()
                                   throws DKException,
                                          java.lang.Exception
Gets a list of privilege sets defined to this admin domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
getPrivSetNames in interface dkAdminDomainDef
Returns:
a list of privilege set names
Throws:
DKException - if error occurs

setPrivSetNames

public void setPrivSetNames(java.lang.String[] s)
                     throws DKException,
                            java.lang.Exception
Sets a list of privilege sets to this admin domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
setPrivSetNames in interface dkAdminDomainDef
Parameters:
s - list of privilege set names
Throws:
DKException - if error occurs

getACLNames

public java.lang.String[] getACLNames()
                               throws DKException,
                                      java.lang.Exception
Gets a list of ACLs defined to this admin domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
getACLNames in interface dkAdminDomainDef
Returns:
a list of ACL names
Throws:
DKException - if error occurs

setACLNames

public void setACLNames(java.lang.String[] s)
                 throws DKException,
                        java.lang.Exception
Sets a list of ACLs to this admin domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
setACLNames in interface dkAdminDomainDef
Parameters:
s - list of ACL names
Throws:
DKException - if error occurs

getResourceMgrNames

public java.lang.String[] getResourceMgrNames()
                                       throws DKException,
                                              java.lang.Exception
Gets a list of Resource Managers defined to this admin domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
getResourceMgrNames in interface dkAdminDomainDef
Returns:
a list of resource manager names
Throws:
DKException - if error occurs

setResourceMgrNames

public void setResourceMgrNames(java.lang.String[] s)
                         throws DKException,
                                java.lang.Exception
Sets a list of Resource Managers to this admin domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
setResourceMgrNames in interface dkAdminDomainDef
Parameters:
s - list of Resource Manager names
Throws:
DKException - if error occurs

getSMSCollectionNames

public java.lang.String[] getSMSCollectionNames()
                                         throws DKException,
                                                java.lang.Exception
Gets a list of collections defined to this admin domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
getSMSCollectionNames in interface dkAdminDomainDef
Returns:
a list of collection names
Throws:
DKException - if error occurs

setSMSCollectionNames

public void setSMSCollectionNames(java.lang.String[] s)
                           throws DKException,
                                  java.lang.Exception
Sets a list of collections to this admin domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
setSMSCollectionNames in interface dkAdminDomainDef
Parameters:
s - list of collection names
Throws:
DKException - if error occurs

EIP Java APIs

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