Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkAbstractPrivilegeGroup

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

public abstract class dkAbstractPrivilegeGroup
extends java.lang.Object
implements dkPrivilegeGroup, DKMessageId, java.io.Serializable

This class defines methods to access privilege information

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
dkAbstractPrivilegeGroup()
          Constructs a new dkAbstractPrivilegeGroup class without owner datastore object.
dkAbstractPrivilegeGroup(dkDatastore ds)
          Constructs a new dkAbstractPrivilegeGroup class with owner datastore object
 
Method Summary
 void addPrivilege(dkPrivilege privObj)
          Adds the given privilege object to the group (memory-only)
 void clearCache()
          Clear privilege group cache
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getDescription()
          gets the description of this privilege group
 java.lang.String getName()
          Gets privilege group name
 java.lang.String[] listPrivilegeNames()
          Gets a list of privilege names defined to the privilege group
 dkCollection listPrivileges()
          Gets a list of privileges defined to the privilege group
 void removePrivilege(java.lang.String name)
          Removes the given privilege from the group (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 privilege group
 void setName(java.lang.String name)
          Sets privilege group name
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

dkAbstractPrivilegeGroup

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

dkAbstractPrivilegeGroup

public dkAbstractPrivilegeGroup(dkDatastore ds)
Constructs a new dkAbstractPrivilegeGroup 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 dkPrivilegeGroup
Following copied from interface: com.ibm.mm.sdk.common.dkPrivilegeGroup
Parameters:
ds - datastore

getDatastore

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

getName

public java.lang.String getName()
Gets privilege group name
Specified by:
getName in interface dkPrivilegeGroup
Returns:
name of this privilege group

setName

public void setName(java.lang.String name)
Sets privilege group name
Specified by:
setName in interface dkPrivilegeGroup
Parameters:
name - new name to be set to this privilege group

getDescription

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

setDescription

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

listPrivileges

public dkCollection listPrivileges()
                            throws DKException,
                                   java.lang.Exception
Gets a list of privileges defined to the privilege group

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listPrivileges in interface dkPrivilegeGroup
Returns:
a dkCollection of dkPrivilege objects

listPrivilegeNames

public java.lang.String[] listPrivilegeNames()
                                      throws DKException,
                                             java.lang.Exception
Gets a list of privilege names defined to the privilege group

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listPrivilegeNames in interface dkPrivilegeGroup
Returns:
an array of privilege names

addPrivilege

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
addPrivilege in interface dkPrivilegeGroup
Parameters:
privObj - privilege object to be added to the group

removePrivilege

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
removePrivilege in interface dkPrivilegeGroup
Parameters:
name - the privilege name to be removed

clearCache

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
clearCache in interface dkPrivilegeGroup

EIP Java APIs

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