|
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 | +--com.ibm.mm.sdk.common.DKUserGroupDefICM
The DKUserGroupDefICM class is the implementation of the abstract class dkAbstractUserGroupDef. Use this class to represent a user group in your program. This class provides facilities to manage a user group in the datastore with actions such as adding, updating users and domains.
dkUserGroupDef.
, Serialized FormFields inherited from interface com.ibm.mm.sdk.common.DKConstant |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdICM |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKUserGroupDefICM()
Constructs and initializes a user group class. |
|
DKUserGroupDefICM(dkDatastore ds)
Constructs and initializes a user group class associated with a given datastore. |
|
DKUserGroupDefICM(java.lang.String userGrpName)
Constructs and initializes a user group class associated with a specified user group name. |
Method Summary | |
void |
addUser(dkUserDef userDef)
Adds a new user to this user group (memory-only) |
void |
clearCache()
Clear user group cache |
java.lang.String |
getDescription()
Gets user group's description |
java.lang.String |
getDomainName()
Gets the administrative domain name that this user group belongs to |
java.lang.String |
getName()
Gets user group name |
java.lang.String |
getNewName()
Deprecated. |
java.lang.String |
getOldName()
Gets user group old name |
java.util.Vector |
getUsers()
Gets a list of users who are assigned to this user group(memory only) |
boolean |
isNameChanged()
Checks to see if the user group name have been changed |
boolean |
isRetrieved()
Checks to see if the users of this group have been retrieved from the datastore. |
java.lang.String[] |
listUserNames()
Gets a list of user names who are assigned to this user group from from datastore. |
dkCollection |
listUsers()
Gets a list of users who are assigned to in this user group from the datastore. |
void |
removeUser(java.lang.String user_name)
Removes a user from this user group (memory-only) |
void |
setDescription(java.lang.String desc)
Sets the description for this user group. |
void |
setDomainName(java.lang.String name)
Sets the administrative domain name that this user group belongs to |
void |
setName(java.lang.String name)
Set user group name |
void |
setNewName(java.lang.String name)
Deprecated. |
void |
setRetrieved(boolean isRetrieved)
Sets whether the users have been retrieved from the datastore. |
void |
setUsers(java.util.Vector vUsers)
Adds a set of users to this user group. |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractUserGroupDef |
datastoreType, getDatastore, setDatastore |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKUserGroupDefICM()
This class represents a user group in the Library Server.
DKUserGroupDefICM userGroup = new DKUserGroupDefICM(); userGroup.setDatastore(ds);
dkUserGroupDef
,
dkAbstractUserGroupDef
public DKUserGroupDefICM(dkDatastore ds)
This class represents a user group in the Library Server.
DKUserGroupDefICM userGroup = new DKUserGroupDefICM(ds);
ds
- - dkDatastore referencedkUserGroupDef
,
dkAbstractUserGroupDef
public DKUserGroupDefICM(java.lang.String userGrpName)
This class represents a user group in the Library Server.
DKUserGroupDefICM userGroup = new DKUserGroupDefICM(String userGrpName);
userGrpName
- string - name of a user group. It can be up to 32 characters long.dkUserGroupDef
,
dkAbstractUserGroupDef
Method Detail |
public java.lang.String getNewName()
public void setNewName(java.lang.String name)
name
- String - new name to be set to this user group object. The new name can be up to 32 characters long.public java.lang.String getDescription()
getDescription
in class dkAbstractUserGroupDef
public void setDescription(java.lang.String desc)
setDescription
in class dkAbstractUserGroupDef
desc
- String - the description of this user group's. The description can be up to 254 characters.public void setUsers(java.util.Vector vUsers) throws DKException, java.lang.Exception
vUsers
- - a vector containing DKUserDefICM object. All the users will be added to this user group.DKException
- when error occurs, for example:if one or more users do not exist in the datastorejava.lang.Exception
- when error occursDKUserDefICM
public java.util.Vector getUsers()
public dkCollection listUsers() throws DKException, java.lang.Exception
listUsers
in class dkAbstractUserGroupDef
DKException
- when error occurs in the serverjava.lang.Exception
- when error occurs in the servergetUsers, listUserNames
public java.lang.String[] listUserNames() throws DKException, java.lang.Exception
listUserNames
in class dkAbstractUserGroupDef
DKException
- if error occursjava.lang.Exception
- if error occurspublic void addUser(dkUserDef userDef) throws DKAlreadyExistException, DKException, java.lang.Exception
addUser
in class dkAbstractUserGroupDef
userDef
- a DKUserDefICM object who is to be added to this user groupDKAlreadyExitsException
- if the userDef already exists in this DKUserGroupICM objectDKException
- when error occursjava.lang.Exception
- when error occursDKUserDefICM
,
dkUserDef
public void removeUser(java.lang.String user_name) throws DKNotExistException, DKException
removeUser
in class dkAbstractUserGroupDef
user_name
- name of the user to be deletedDKNotExistException
- if the user name does not exist in this user group.DKException
- when error occurspublic java.lang.String getDomainName()
public void setDomainName(java.lang.String name)
name
- String - adminadministrative domain name to which this user group belongs to
The domain name can be up to 32 characters.public boolean isRetrieved()
public void setRetrieved(boolean isRetrieved)
isRetrieved
- - true if users are already retrieved from the datastore, false otherwisepublic void clearCache() throws DKException, java.lang.Exception
clearCache
in class dkAbstractUserGroupDef
public void setName(java.lang.String name)
setName
in class dkAbstractUserGroupDef
name
- String - name of this user grouppublic java.lang.String getName()
getName
in class dkAbstractUserGroupDef
public boolean isNameChanged()
public java.lang.String getOldName()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |