Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkPrivilegeSet

All Known Implementing Classes:
dkAbstractPrivilegeSet

public interface dkPrivilegeSet


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 privilege set
 java.lang.String getName()
          gets the name of this privilege set
 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 privilege set
 void setName(java.lang.String name)
          sets the name for this privilege set
 

Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Parameters:
ds - datastore

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Returns:
the dkDatastore object

getName

public java.lang.String getName()
gets the name of this privilege set
Returns:
privilege set name

setName

public void setName(java.lang.String name)
sets the name for this privilege set
Parameters:
name - privilege set name

getDescription

public java.lang.String getDescription()
gets the description of this privilege set
Returns:
privilege set description

setDescription

public void setDescription(java.lang.String description)
sets the description of this privilege set
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

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

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

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

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

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


EIP Java APIs

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