Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkAdminDomainDef

All Known Implementing Classes:
dkAbstractAdminDomainDef

public interface dkAdminDomainDef

The dkAdminDomainDef class represents an administrative domain object.

See Also:
DKAdminDomainDefFed, DKAdminDomainDefICM

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
 

Method Detail

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Returns:
the dkDatastore object

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Parameters:
ds - datastore object

getName

public java.lang.String getName()
Gets admin domain name
Returns:
name of this admin domain

setName

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

getDescription

public java.lang.String getDescription()
gets the description of this admin domain
Returns:
the admin domain description

setDescription

public void setDescription(java.lang.String description)
sets the description of this admin domain
Parameters:
description - admin domain description

getID

public int getID()
gets the ID of this admin domain
Returns:
the admin domain id

setID

public void setID(int id)
sets the ID of this admin domain
Parameters:
id - - the admin domain id

getNLSLanguage

public java.lang.String getNLSLanguage()
gets the NLS language of this admin domain
Returns:
the NLS language for the domain

setNLSLanguage

public void setNLSLanguage(java.lang.String langCode)
sets the NLS language for this admin domain
Parameters:
langCode - 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

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

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

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

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

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

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

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

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

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

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

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

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.