Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkAbstractPrivilegeSet

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractPrivilegeSet
All Implemented Interfaces:
DKMessageId, dkPrivilegeSet, java.io.Serializable
Direct Known Subclasses:
DKPrivilegeSetFed, DKPrivilegeSetICM

public abstract class dkAbstractPrivilegeSet
extends java.lang.Object
implements dkPrivilegeSet, DKMessageId, java.io.Serializable

This class defines methods to access user information

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
dkAbstractPrivilegeSet()
          Constructs a new dkAbstractPrivilegeSet class without owner datastore object.
dkAbstractPrivilegeSet(dkDatastore ds)
          Constructs a new dkAbstractPrivilegeSet class with owner datastore object
 
Method Summary
 void addPrivilege(dkPrivilege privObj)
          Adds the given privilege object (memory-only)
 void addPrivilegeGroup(dkPrivilegeGroup privGroupObj)
          Adds the given privilege group object (memory-only)
 void clearCache()
          Clear privilege set cache
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getDescription()
          gets the description of this action list
 java.lang.String getName()
          Gets User name
 java.lang.String[] listPrivilegeNames()
          Gets a list of privilege names from persistent datastore
 dkCollection listPrivileges()
          Gets a list of privileges from persistent datastore
 void removePrivilege(java.lang.String privName)
          Removes the given privilege object (memory-only)
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setDescription(java.lang.String description)
          sets the description of this action list
 void setName(java.lang.String name)
          Sets User name
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

dkAbstractPrivilegeSet

public dkAbstractPrivilegeSet()
Constructs a new dkAbstractPrivilegeSet class without owner datastore object.

dkAbstractPrivilegeSet

public dkAbstractPrivilegeSet(dkDatastore ds)
Constructs a new dkAbstractPrivilegeSet class with owner datastore object
Parameters:
ds - reference to owner datastore object
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Specified by:
setDatastore in interface dkPrivilegeSet
Following copied from interface: com.ibm.mm.sdk.common.dkPrivilegeSet
Parameters:
ds - datastore

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Specified by:
getDatastore in interface dkPrivilegeSet
Returns:
the dkDatastore object

getName

public java.lang.String getName()
Gets User name
Specified by:
getName in interface dkPrivilegeSet
Returns:
name of this user

setName

public void setName(java.lang.String name)
Sets User name
Specified by:
setName in interface dkPrivilegeSet
Parameters:
name - new name to be set to this User object

getDescription

public java.lang.String getDescription()
gets the description of this action list
Specified by:
getDescription in interface dkPrivilegeSet
Following copied from interface: com.ibm.mm.sdk.common.dkPrivilegeSet
Returns:
privilege set description

setDescription

public void setDescription(java.lang.String description)
sets the description of this action list
Specified by:
setDescription in interface dkPrivilegeSet
Following copied from interface: com.ibm.mm.sdk.common.dkPrivilegeSet
Parameters:
description - privilege set description

listPrivileges

public dkCollection listPrivileges()
                            throws DKException,
                                   java.lang.Exception
Gets a list of privileges from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listPrivileges in interface dkPrivilegeSet
Returns:
a collection of dkPrivilege objects
Throws:
DKException - if error occurs

listPrivilegeNames

public java.lang.String[] listPrivilegeNames()
                                      throws DKException,
                                             java.lang.Exception
Gets a list of privilege names from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listPrivilegeNames in interface dkPrivilegeSet
Returns:
an array of privilege names
Throws:
DKException - if error occurs

addPrivilege

public void addPrivilege(dkPrivilege privObj)
                  throws DKException,
                         java.lang.Exception
Adds the given privilege object (memory-only)

Note:DKUsageError exception thrown if method is not implemented

Specified by:
addPrivilege in interface dkPrivilegeSet
Parameters:
privObj - privilege object to be added.
Throws:
DKException - if error

removePrivilege

public void removePrivilege(java.lang.String privName)
                     throws DKException,
                            java.lang.Exception
Removes the given privilege object (memory-only)

Note:DKUsageError exception thrown if method is not implemented

Specified by:
removePrivilege in interface dkPrivilegeSet
Parameters:
privName - privilege object to be remove.
Throws:
DKException - if error

addPrivilegeGroup

public void addPrivilegeGroup(dkPrivilegeGroup privGroupObj)
                       throws DKException,
                              java.lang.Exception
Adds the given privilege group object (memory-only)

Note:DKUsageError exception thrown if method is not implemented

Specified by:
addPrivilegeGroup in interface dkPrivilegeSet
Parameters:
privGroupObj - privilege group object to be added.
Throws:
DKException - if error

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear privilege set cache

Note:DKUsageError exception thrown if method is not implemented

Specified by:
clearCache in interface dkPrivilegeSet

EIP Java APIs

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