|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractUserGroupDef
This class defines methods to access user group information
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 |
public dkAbstractUserGroupDef()
public dkAbstractUserGroupDef(dkDatastore ds)
ds
- reference to owner datastore objectMethod Detail |
public void setDatastore(dkDatastore ds)
setDatastore
in interface dkUserGroupDef
com.ibm.mm.sdk.common.dkUserGroupDef
ds
- datastorepublic dkDatastore getDatastore()
getDatastore
in interface dkUserGroupDef
public java.lang.String datastoreType() throws java.lang.Exception
datastoreType
in interface dkUserGroupDef
DKException
- if error occurspublic java.lang.String getName()
getName
in interface dkUserGroupDef
public void setName(java.lang.String name)
setName
in interface dkUserGroupDef
name
- new name to be set to this User group objectpublic java.lang.String getDescription()
getDescription
in interface dkUserGroupDef
public void setDescription(java.lang.String desc)
setDescription
in interface dkUserGroupDef
desc
- description about this userpublic dkCollection listUsers() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
listUsers
in interface dkUserGroupDef
public java.lang.String[] listUserNames() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
listUserNames
in interface dkUserGroupDef
public void addUser(dkUserDef userDefObj) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
addUser
in interface dkUserGroupDef
attrObj
- attribute object to be added.public void removeUser(java.lang.String userName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
removeUser
in interface dkUserGroupDef
userName
- the user namepublic void clearCache() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
clearCache
in interface dkUserGroupDef
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |