Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkPrivilegeGroup

All Known Implementing Classes:
dkAbstractPrivilegeGroup

public interface dkPrivilegeGroup


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 the name of this privilege group
 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 the name for this privilege group
 

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 group
Returns:
privilege group name

setName

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

getDescription

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

setDescription

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

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

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

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

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


EIP Java APIs

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