Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkUserGroupDef

All Known Implementing Classes:
dkAbstractUserGroupDef

public interface dkUserGroupDef

dkUserGroupDef : This class represents a user group definition.


Method Summary
 void addUser(dkUserDef userDefObj)
          Adds the given user object to the group memory only
 void clearCache()
          Clear user group cache
 java.lang.String datastoreType()
          Gets datastore type
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getDescription()
          Get the description of this user group
 java.lang.String getName()
          Gets user group name
 java.lang.String[] listUserNames()
          Gets a list of user names defined to the user group
 dkCollection listUsers()
          Gets a list of user defined to the user group
 void removeUser(java.lang.String userName)
          Deletes the given user object from the group memory only
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setDescription(java.lang.String desc)
          Sets description of this user group
 void setName(java.lang.String name)
          Sets user group name
 

Method Detail

setDatastore

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

getDatastore

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

getName

public java.lang.String getName()
Gets user group name
Returns:
name of this user group

setName

public void setName(java.lang.String name)
Sets user group name
Parameters:
name - name of this user group object

datastoreType

public java.lang.String datastoreType()
                               throws java.lang.Exception
Gets datastore type
Returns:
name of type of datastore this user group belongs to

getDescription

public java.lang.String getDescription()
Get the description of this user group
Returns:
string containing description.

setDescription

public void setDescription(java.lang.String desc)
Sets description of this user group
Parameters:
desc - description about this user

listUsers

public dkCollection listUsers()
                       throws DKException,
                              java.lang.Exception
Gets a list of user defined to the user group

Note:DKUsageError exception thrown if method is not implemented

Returns:
a dkCollection of dkUserDef objects

listUserNames

public java.lang.String[] listUserNames()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of user names defined to the user group

Note:DKUsageError exception thrown if method is not implemented

Returns:
an array of attribute names

addUser

public void addUser(dkUserDef userDefObj)
             throws DKException,
                    java.lang.Exception
Adds the given user object to the group memory only

Note:DKUsageError exception thrown if method is not implemented

Parameters:
userDefObj - attribute object to be added.

removeUser

public void removeUser(java.lang.String userName)
                throws DKException,
                       java.lang.Exception
Deletes the given user object from the group memory only

Note:DKUsageError exception thrown if method is not implemented

Parameters:
userName - the user name to be removed.

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear user group cache

Note:DKUsageError exception thrown if method is not implemented


EIP Java APIs

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