|
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.DKUserGroupDataFed
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed |
For details, see the class or interface |
Fields 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.DKMessageIdFed |
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 | |
DKUserGroupDataFed()
Constructs and initializes a user group class. |
|
DKUserGroupDataFed(dkDatastore ds)
Constructs and initializes a user group class associated with a given datastore. |
|
DKUserGroupDataFed(java.lang.String name)
Constructs and initializes a user group class associated with a specified name. |
Method Summary | |
void |
addUser(dkUserDef userDef)
Adds a new user to this user group (memory-only) |
void |
clearCache()
Clear user group cache |
long |
getDomainId()
Gets the admin domain id that this user group belongs to |
java.lang.String |
getDomainName()
Gets the admin domain name that this user group belongs to |
java.lang.String |
getNewUserGroupName()
Deprecated. |
int |
getUserGroupID()
Deprecated. |
java.lang.String |
getUserGroupName()
Deprecated. |
java.util.Vector |
getUsers()
Gets users from this user group |
boolean |
isRetrieved()
Checks whether the users of this group have been retrieved |
java.lang.String[] |
listUserNames()
Gets a list of user names defined to the user group from persistent datastore, if not cached |
dkCollection |
listUsers()
Gets a list of users in this user group from the persistent datastore |
void |
removeUser(java.lang.String userName)
Removes a user from this user group (memory-only) |
void |
setDomainId(long id)
Sets admin domain ide that this user group belongs to |
void |
setDomainName(java.lang.String name)
Sets admin domain name that this user group belongs to |
void |
setNewUserGroupName(java.lang.String name)
Deprecated. |
void |
setRetrieved(boolean isRetrieved)
Sets whether the user has been retrieved |
void |
setUserGroupID(int id)
Set the ID that representing this UserGroup in the Federated database. |
void |
setUserGroupName(java.lang.String name)
Deprecated. |
void |
setUsers(java.util.Vector v)
Sets users to this user group |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractUserGroupDef |
datastoreType, getDatastore, getDescription, getName, setDatastore, setDescription, setName |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKUserGroupDataFed()
This class represents a user group in the Library Server.
DKUserGroupDataFed userGroup = new DKUserGroupDataFed();
dkUserGroupDef
,
dkAbstractUserGroupDef
public DKUserGroupDataFed(java.lang.String name)
This class represents a user group in the Library Server.
DKUserGroupDataFed userGroup = new DKUserGroupDataFed(String name);
String
- name referencedkUserGroupDef
,
dkAbstractUserGroupDef
public DKUserGroupDataFed(dkDatastore ds)
This class represents a user group in the Library Server.
DKUserGroupDataFed userGroup = new DKUserGroupDataFed(ds);
ds
- dkDatastore referencedkUserGroupDef
,
dkAbstractUserGroupDef
Method Detail |
public java.lang.String getUserGroupName()
public void setUserGroupName(java.lang.String name)
name(String)
- - the name for the userpublic java.lang.String getNewUserGroupName() throws java.lang.Exception
public void setNewUserGroupName(java.lang.String name) throws java.lang.Exception
public int getUserGroupID() throws java.lang.Exception
public void setUserGroupID(int id) throws java.lang.Exception
public boolean isRetrieved()
public void setRetrieved(boolean isRetrieved)
isRetrieved
- true if already retrieved, false otherwisepublic void setUsers(java.util.Vector v) throws DKException, java.lang.Exception
v
- a vector containing DKUserDefFed objectpublic java.util.Vector getUsers()
v
- a vector containing DKUserDefFed objectpublic dkCollection listUsers() throws DKException, java.lang.Exception
listUsers
in class dkAbstractUserGroupDef
DKException
- when error occurs in the serverpublic java.lang.String[] listUserNames() throws DKException, java.lang.Exception
listUserNames
in class dkAbstractUserGroupDef
public void addUser(dkUserDef userDef) throws DKAlreadyExistException, DKException, java.lang.Exception
addUser
in class dkAbstractUserGroupDef
userDef
- a DKUserDataFed objectDKAlreadyExitsException
- if the userDef already exists in this DKUserGroupDataFed objectDKException
- when error occursjava.lang.Exception
- when error occursDKUserDataFed
,
dkUserDef
public void removeUser(java.lang.String userName) throws DKNotExistException, DKException
removeUser
in class dkAbstractUserGroupDef
userName
- 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 - admin domain name of this user group belongs topublic long getDomainId()
public void setDomainId(long id)
id
- long - admin domain id of this user group belongs topublic void clearCache() throws DKException, java.lang.Exception
clearCache
in class dkAbstractUserGroupDef
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |