|
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.dkAbstractPrivilegeSet | +--com.ibm.mm.sdk.common.DKPrivilegeSetICM
A Content Manager privilege set is a named group of privileges. The purpose of using privilege sets is to ease system administration. Content Manager privileges must be grouped into privilege sets before they can be granted to users or used to define ACLs. Privilege sets granted to users are called user privileges. They define the individual users' individual bounds on using the system. When applied to ACL specifications, the privilege set specify the limits of the operations allowed on the bound Controlled Entity. Only individual users can be associated with privilege sets. User groups cannot hold privilege sets for their members. The DKPrivilegeSetICM class is used to represent Content Manager privilege sets.
DKPrivilegeGroupICM
,
DKPrivilegeICM
, 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 | |
DKPrivilegeSetICM()
Default constructor. |
|
DKPrivilegeSetICM(dkDatastore ds)
Constructor that takes a datastore instance as a parameter. |
Method Summary | |
void |
addPrivilege(dkPrivilege privObj)
Adds a new privilege to the in-memory (cached) representation of the privilege set instance. |
void |
addPrivilegeGroup(dkPrivilegeGroup privGroupObj)
Adds a privilege group to the in-memory (cached) representation of the privilege set instance. |
void |
clearCache()
Clears the privilege set cache by removing all contained privileges from the in-memory (cached) representation of this privilege set . |
dkCollection |
getAdminDomains()
Retrieves the collection of domains with which this privilege set instance is associated. |
long |
getID()
Returns the identifier associated with this privilege set instance. |
boolean |
isRetrieved()
Checks to see if the privileges comprising this privilege set have been retrieved from the datastore |
java.lang.String[] |
listPrivilegeNames()
Retrieves the name of all the privileges associated with this privilege set from the datastore if caching is turned off or if caching is on but the privilege names have not yet been retrieved into the in-memory cache. |
dkCollection |
listPrivileges()
Retrieves the list of privileges associated with this privilege set from the datastore. |
void |
removePrivilege(long priv_id)
Removes the privilege object instance corresponding to the privilege identifier specified in the input parameter, from the in-memory representation of this privilege set instance. |
void |
removePrivilege(java.lang.String priv_name)
Removes the privilege object corresponding to the privilege name specified in the input parameter, from the in-memory representation of this privilege set instance. |
void |
setAdminDomains(dkCollection collDomain)
Sets the admininstration domains that this privilege set object is associated with. |
void |
setID(long id)
Sets the privilege group identifier. |
void |
setRetrieved(boolean isRetrieved)
Sets a value that determines whether the privileges comprising this privilege set was retrieved from the datastore or not |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractPrivilegeSet |
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 DKPrivilegeSetICM()
public DKPrivilegeSetICM(dkDatastore ds)
ds
- datastore reference. Should be an instance of DKDatastoreICMdkDatastore
,
DKDatastoreICM
Method Detail |
public void setID(long id)
id
- the new identifier to be associated with this privilege set instancepublic long getID()
public void setAdminDomains(dkCollection collDomain)
collDomain
- collection of DKAdminDomainDefICM object instances with which this privilege set will henceforth be associatedDKAdminDomainDefICM
public dkCollection getAdminDomains()
DKAdminDomainDefICM
public boolean isRetrieved()
public void setRetrieved(boolean isRetrieved)
isRetrieved
- if true, the privileges comprising this privilege set are considered to have been retrieved from the data;
if false,the privileges comprising this privilege set are considered to not have been retrievedpublic dkCollection listPrivileges() throws DKException, java.lang.Exception
listPrivileges
in class dkAbstractPrivilegeSet
DKException
- when error occurs in the serverjava.lang.Exception
- when error occurs in the serverDKPrivilegeICM
public java.lang.String[] listPrivilegeNames() throws DKException, java.lang.Exception
listPrivilegeNames
in class dkAbstractPrivilegeSet
DKException
- if error occursjava.lang.Exception
- if error occurspublic void addPrivilege(dkPrivilege privObj) throws DKAlreadyExistException, DKException, java.lang.Exception
addPrivilege
in class dkAbstractPrivilegeSet
privObj
- a valid DKPriviligeICM instance.DKAlreadyExitsException
- if the privObj already exists in this DKPrivilegeSetICM objectDKException
- when error occursjava.lang.Exception
- when error occursDKPrivilegeICM
,
dkPrivilege
public void removePrivilege(java.lang.String priv_name) throws DKNotExistException, DKException
removePrivilege
in class dkAbstractPrivilegeSet
priv_name
- name of the privilege to be removedDKNotExistException
- if the privilege name does not exist in this privilege set.DKException
- when error occurspublic void removePrivilege(long priv_id) throws DKNotExistException, DKException
priv_id
- identifier of the privilege to be removedDKNotExistException
- if the privilege id does not exist in the privilege setDKException
- when error occurspublic void addPrivilegeGroup(dkPrivilegeGroup privGroupObj) throws DKException, java.lang.Exception
addPrivilegeGroup
in class dkAbstractPrivilegeSet
privGroupObj
- valid privilege group object as an instance of DKPriviligeGroupICM.DKException
- if error occursjava.lang.Exception
- if error occursdkPrivilegeGroup
public void clearCache() throws DKException, java.lang.Exception
clearCache
in class dkAbstractPrivilegeSet
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |