Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKPrivilegeGroupFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractPrivilegeGroup
        |
        +--com.ibm.mm.sdk.common.DKPrivilegeGroupFed
All Implemented Interfaces:
DKMessageId, dkPrivilegeGroup, java.io.Serializable

public class DKPrivilegeGroupFed
extends dkAbstractPrivilegeGroup
implements java.io.Serializable

DKPrivilegeSetFed : This class represents a privilege set.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKPrivilegeGroupFed()
          Default constructor Constructs the privilege group.
DKPrivilegeGroupFed(dkDatastore ds)
          Constructs the privilege set and initializes it with the datastore.
 
Method Summary
 void addPrivilege(dkPrivilege privObj)
          Adds a new privilege to this privilege group (memory only)
 void clearCache()
          Clear privilege group cache
 long getID()
          Gets privilege group id
 java.util.Vector getPrivileges()
          Gets privileges from this privilege group
 java.lang.String[] listPrivilegeNames()
          Gets a list of privilege Group names defined to the privilege group from persistent datastore, if not cached
 dkCollection listPrivileges()
          Gets a list of privileges in this privilege group from the persistent datastore
 void removePrivilege(long priv_id)
          removes a privilege from this privilege group (memory-only)
 void removePrivilege(java.lang.String priv_name)
          removes a privilege from this privilege group (memory-only)
 void setID(long id)
          Sets privilege group id
 void setPrivileges(java.util.Vector v)
          Sets privileges to this privilege group
 void setRetrieved(boolean isRetrieved)
          Sets whether the privileges has been retrieved
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractPrivilegeGroup
getDatastore, getDescription, getName, setDatastore, setDescription, setName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKPrivilegeGroupFed

public DKPrivilegeGroupFed()
Default constructor Constructs the privilege group.

DKPrivilegeGroupFed

public DKPrivilegeGroupFed(dkDatastore ds)
Constructs the privilege set and initializes it with the datastore.
Parameters:
ds - dkDatastore reference
name - name of access control list
Method Detail

setID

public void setID(long id)
Sets privilege group id
Parameters:
id - new id to be set to this privilege group object

getID

public long getID()
Gets privilege group id
Returns:
id of this privilege group

setRetrieved

public void setRetrieved(boolean isRetrieved)
Sets whether the privileges has been retrieved
Parameters:
isRetrieved - true if already retrieved, false otherwise

setPrivileges

public void setPrivileges(java.util.Vector v)
                   throws DKException,
                          java.lang.Exception
Sets privileges to this privilege group
Parameters:
v - a vector containing DKPrivilegeFed object

getPrivileges

public java.util.Vector getPrivileges()
Gets privileges from this privilege group
Parameters:
v - a vector containing DKPrivilegeFed object

listPrivileges

public dkCollection listPrivileges()
                            throws DKException,
                                   java.lang.Exception
Gets a list of privileges in this privilege group from the persistent datastore
Overrides:
listPrivileges in class dkAbstractPrivilegeGroup
Returns:
a collection of privilege objects
Throws:
DKException - when error occurs in the server

listPrivilegeNames

public java.lang.String[] listPrivilegeNames()
                                      throws DKException,
                                             java.lang.Exception
Gets a list of privilege Group names defined to the privilege group from persistent datastore, if not cached
Overrides:
listPrivilegeNames in class dkAbstractPrivilegeGroup
Returns:
an array of privilege names

addPrivilege

public void addPrivilege(dkPrivilege privObj)
                  throws DKAlreadyExistException,
                         DKException,
                         java.lang.Exception
Adds a new privilege to this privilege group (memory only)
Overrides:
addPrivilege in class dkAbstractPrivilegeGroup
Parameters:
priv - a DKPrivilegeFed object

removePrivilege

public void removePrivilege(java.lang.String priv_name)
                     throws DKNotExistException,
                            DKException
removes a privilege from this privilege group (memory-only)
Overrides:
removePrivilege in class dkAbstractPrivilegeGroup
Parameters:
priv_name - name of the privilege to be removed

removePrivilege

public void removePrivilege(long priv_id)
                     throws DKNotExistException,
                            DKException
removes a privilege from this privilege group (memory-only)
Parameters:
priv_id - id of the privilege to be removed

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear privilege group cache
Overrides:
clearCache in class dkAbstractPrivilegeGroup

EIP Java APIs

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