Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkAbstractUserGroupDef

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractUserGroupDef
All Implemented Interfaces:
DKMessageId, dkUserGroupDef, java.io.Serializable
Direct Known Subclasses:
DKUserGroupDataFed, DKUserGroupDefICM

public abstract class dkAbstractUserGroupDef
extends java.lang.Object
implements dkUserGroupDef, DKMessageId, java.io.Serializable

This class defines methods to access user group information

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
dkAbstractUserGroupDef()
          Constructs a new dkAbstractUserGroupDef class without owner datastore object.
dkAbstractUserGroupDef(dkDatastore ds)
          Constructs a new dkAbstractUserGroupDef class with owner datastore object
 
Method Summary
 void addUser(dkUserDef userDefObj)
          Adds the given user object to the group memory
 void clearCache()
          Clear datastore cache
 java.lang.String datastoreType()
          Gets the type for this datastore object
 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
 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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

dkAbstractUserGroupDef

public dkAbstractUserGroupDef()
Constructs a new dkAbstractUserGroupDef class without owner datastore object.

dkAbstractUserGroupDef

public dkAbstractUserGroupDef(dkDatastore ds)
Constructs a new dkAbstractUserGroupDef class with owner datastore object
Parameters:
ds - reference to owner datastore object
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Specified by:
setDatastore in interface dkUserGroupDef
Following copied from interface: com.ibm.mm.sdk.common.dkUserGroupDef
Parameters:
ds - datastore

getDatastore

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

datastoreType

public java.lang.String datastoreType()
                               throws java.lang.Exception
Gets the type for this datastore object
Specified by:
datastoreType in interface dkUserGroupDef
Returns:
datastore type
Throws:
DKException - if error occurs

getName

public java.lang.String getName()
Gets User group name
Specified by:
getName in interface dkUserGroupDef
Returns:
name of this user group

setName

public void setName(java.lang.String name)
Sets User group name
Specified by:
setName in interface dkUserGroupDef
Parameters:
name - new name to be set to this User group object

getDescription

public java.lang.String getDescription()
Get the description of this user group
Specified by:
getDescription in interface dkUserGroupDef
Returns:
string containing description.

setDescription

public void setDescription(java.lang.String desc)
Sets description of this user group
Specified by:
setDescription in interface dkUserGroupDef
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

Specified by:
listUsers in interface dkUserGroupDef
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

Specified by:
listUserNames in interface dkUserGroupDef
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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
addUser in interface dkUserGroupDef
Parameters:
attrObj - 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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
removeUser in interface dkUserGroupDef
Parameters:
userName - the user name

clearCache

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
clearCache in interface dkUserGroupDef

EIP Java APIs

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