Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKPrivilegeSetFed

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

public class DKPrivilegeSetFed
extends dkAbstractPrivilegeSet

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKPrivilegeSetFed()
          Constructor - with blank name
DKPrivilegeSetFed(dkDatastore ds)
          Constructor - create a new privilege set with a given name and description
DKPrivilegeSetFed(dkDatastore ds, java.lang.String name, java.lang.String description)
          Constructor - create a new privilege set with a given name and description
DKPrivilegeSetFed(DKPid fromPid)
          Deprecated. no meaning
DKPrivilegeSetFed(java.lang.String pidID)
          Constructs a data object with given Pid.
 
Method Summary
 void add()
          Deprecated.  
 void addPrivilege(dkPrivilege privObj)
          Adds a new privilege to this privilege set (memory-only)
 void addPrivilegeGroup(dkPrivilegeGroup privGroupObj)
          Adds the given privilege group object to this privilege set (memory-only)
 void checkin()
          Deprecated. no meaning
 void checkout()
          Deprecated. no meaning
 void clearCache()
          Clear privilege set cache
 void del()
          Deprecated.  
 dkCollection getAdminDomains()
          Gets the collection of domains that this privilege set belongs to
 java.lang.String getCheckedOutUserid()
          Deprecated. no meaning
 long getID()
          Gets privilege set id
 java.lang.String getObjectType()
          Deprecated. no meaning
 DKPid getPid()
          Deprecated. no meaning
 DKCommonPrivilege getPrivilege()
          Deprecated.  
 boolean isRetrieved()
          Checks to see if the privileges have been retrieved
 java.lang.String[] listPrivilegeNames()
          Gets a list of privilege names from persistent datastore
 dkCollection listPrivileges()
          Gets a list of privileges in this privilege set (persistent)
 void removePrivilege(long priv_id)
          removes a privilege from this privilege set (memory-only)
 void removePrivilege(java.lang.String priv_name)
          Removes a privilege from this privilege set (memory-only)
 void retrieve()
          Deprecated.  
 void setAdminDomains(dkCollection collDomain)
          Sets domains that this privilege set belongs to
 void setID(long id)
          Sets privilege set id
 void setObjectType(java.lang.String toObjectType)
          Deprecated. no meaning
 void setPid(DKPid fromPid)
          Deprecated. no meaning
 void setPrivilege(DKCommonPrivilege cmnPriv)
          Deprecated.  
 void setRetrieved(boolean isRetrieved)
          Sets whether the privileges has been retrieved
 void unlockCheckedOut()
          Deprecated. no meaning
 void update()
          Deprecated.  
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractPrivilegeSet
getDatastore, getDescription, getName, setDatastore, setDescription, setName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKPrivilegeSetFed

public DKPrivilegeSetFed()
Constructor - with blank name

DKPrivilegeSetFed

public DKPrivilegeSetFed(DKPid fromPid)
                  throws java.lang.Exception
Deprecated. no meaning

Constructs a data object with given Pid.
Parameters:
fromPid - pid.

DKPrivilegeSetFed

public DKPrivilegeSetFed(java.lang.String pidID)
                  throws java.lang.Exception
Constructs a data object with given Pid.
Parameters:
pidID - persistent id of this object

DKPrivilegeSetFed

public DKPrivilegeSetFed(dkDatastore ds)
Constructor - create a new privilege set with a given name and description
Parameters:
ds - dkDatastore

DKPrivilegeSetFed

public DKPrivilegeSetFed(dkDatastore ds,
                         java.lang.String name,
                         java.lang.String description)
Constructor - create a new privilege set with a given name and description
Parameters:
name - String - name of the privilege set
description - String - description of the privilege set
Method Detail

setID

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

getID

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

setAdminDomains

public void setAdminDomains(dkCollection collDomain)
Sets domains that this privilege set belongs to
Parameters:
collDomain - a collection of DKAdminDomainDefFed this privilege set object belongs to

getAdminDomains

public dkCollection getAdminDomains()
Gets the collection of domains that this privilege set belongs to
Returns:
a collection of DKAdminDomainDefFed that this privilege set belongs to

isRetrieved

public boolean isRetrieved()
Checks to see if the privileges have been retrieved
Returns:
true if already retrieved, false otherwise

setRetrieved

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

listPrivileges

public dkCollection listPrivileges()
                            throws DKException,
                                   java.lang.Exception
Gets a list of privileges in this privilege set (persistent)
Overrides:
listPrivileges in class dkAbstractPrivilegeSet
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 names from persistent datastore
Overrides:
listPrivilegeNames in class dkAbstractPrivilegeSet
Returns:
an array of privilege names
Throws:
DKException - if error occurs

addPrivilege

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

removePrivilege

public void removePrivilege(java.lang.String priv_name)
                     throws DKNotExistException,
                            DKException
Removes a privilege from this privilege set (memory-only)
Overrides:
removePrivilege in class dkAbstractPrivilegeSet
Parameters:
priv_name - name of the privilege to be deleted

removePrivilege

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

addPrivilegeGroup

public void addPrivilegeGroup(dkPrivilegeGroup privGroupObj)
                       throws DKException,
                              java.lang.Exception
Adds the given privilege group object to this privilege set (memory-only)
Overrides:
addPrivilegeGroup in class dkAbstractPrivilegeSet
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
Overrides:
clearCache in class dkAbstractPrivilegeSet

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Deprecated.  

Retrieves information of the privilege set

add

public void add()
         throws DKAlreadyExistException,
                DKException,
                java.lang.Exception
Deprecated.  

Adds a new privilege set

update

public void update()
            throws DKNotCheckedOutException,
                   DKException,
                   java.lang.Exception
Deprecated.  

Updates an existing privilege set

del

public void del()
         throws DKNotExistException,
                DKException,
                java.lang.Exception
Deprecated.  

Deletes an existing privilege set

checkin

public void checkin()
             throws DKNotCheckedOutException,
                    DKException,
                    java.lang.Exception
Deprecated. no meaning

checks in the object data
Throws:
DKNotCheckedOutException - if this item is not currently checked out

checkout

public void checkout()
              throws DKAlreadyCheckedOutException,
                     DKException,
                     java.lang.Exception
Deprecated. no meaning

checks out the object data
Throws:
DKAlreadyCheckedOutException - if this item is currently checked out by another user.

unlockCheckedOut

public void unlockCheckedOut()
                      throws DKNotCheckedOutException,
                             DKException,
                             java.lang.Exception
Deprecated. no meaning

unlocks currently checked out object data
Throws:
DKNotCheckedOutException - if this item is not currently checked out

getCheckedOutUserid

public java.lang.String getCheckedOutUserid()
                                     throws DKNotCheckedOutException,
                                            DKException,
                                            java.lang.Exception
Deprecated. no meaning

gets the checked out userid
Returns:
String - userid that checked out the object
Throws:
DKNotCheckedOutException - if this item is not currently checked out

getPrivilege

public DKCommonPrivilege getPrivilege()
                               throws java.lang.Exception
Deprecated.  

Gets the common privilege
Returns:
DKCommonPrivilege object

setPrivilege

public void setPrivilege(DKCommonPrivilege cmnPriv)
                  throws java.lang.Exception
Deprecated.  

Sets the common privilege
Parameters:
cmnPriv - new privilege

getObjectType

public java.lang.String getObjectType()
                               throws java.lang.Exception
Deprecated. no meaning

Gets the type of this data-object.
Returns:
the object type.

setObjectType

public void setObjectType(java.lang.String toObjectType)
                   throws java.lang.Exception
Deprecated. no meaning

Sets the type of this data-object and synchronizes it with the object type of its Pid.
Parameters:
toObjectType - the object type.

getPid

public DKPid getPid()
             throws java.lang.Exception
Deprecated. no meaning

Gets the pid of this data object.
Returns:
the pid.

setPid

public void setPid(DKPid fromPid)
            throws DKException
Deprecated. no meaning

Sets the pid of this data object
Parameters:
fromPid - pid
Throws:
DKException - If provided pid is null

EIP Java APIs

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