Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKACLData

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

public class DKACLData
extends java.lang.Object
implements java.io.Serializable, DKConstant, DKMessageId

This class represents access list data.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKACLData()
          Constructs and initializes a rule of an access control list.
DKACLData(dkPrivilegeSet privSet, java.lang.String usrGrpName, short usrGrpType)
          Constructs new DKACLData object with privilege set and user/user group name
 
Method Summary
 short getPatronType()
          Gets the patron type associated with this object
 dkPrivilegeSet getPrivilegeSet()
          Gets the privilege set associated with this object
 java.lang.String getPrivilegeSetName()
          Gets the name of the privilege set associated with this object
 java.lang.String getUserGroupName()
          Gets the user or group name associated with this object
 boolean isGroup()
          Gets the patron type associated with this object.
 boolean isUser()
          Gets the patron type associated with this object.
 void setPatronType(short type)
          Sets the patron type of this pbject
 void setPrivilegeSet(dkPrivilegeSet privSet)
          Sets the privilege set for this object
 void setUserGroupName(java.lang.String usrGrpName)
          Sets the user or group name for this object
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKACLData

public DKACLData()
Constructs and initializes a rule of an access control list.

This class represents a rule in an access control list in the Library Server.

  DKACLData aclData = new DKACLData();
  

DKACLData

public DKACLData(dkPrivilegeSet privSet,
                 java.lang.String usrGrpName,
                 short usrGrpType)
Constructs new DKACLData object with privilege set and user/user group name
Parameters:
privSet - a dkPrivilegeSet object
usrGrpName - name of user or user group
usrGrpType - either DK_CM_USER_KIND_USER or DK_CM_USER_KIND_GROUP or DK_CM_USER_KIND_PUBLIC
Method Detail

setPrivilegeSet

public void setPrivilegeSet(dkPrivilegeSet privSet)
Sets the privilege set for this object
Parameters:
privSet - a dkPrivilegeSet object

getPrivilegeSet

public dkPrivilegeSet getPrivilegeSet()
Gets the privilege set associated with this object
Returns:
dkPrivilegeSet object

getPrivilegeSetName

public java.lang.String getPrivilegeSetName()
Gets the name of the privilege set associated with this object
Returns:
privilege set name

setUserGroupName

public void setUserGroupName(java.lang.String usrGrpName)
Sets the user or group name for this object
Parameters:
usrGrpName - name of user or user group

getUserGroupName

public java.lang.String getUserGroupName()
Gets the user or group name associated with this object
Returns:
user or user group name

getPatronType

public short getPatronType()
Gets the patron type associated with this object
Returns:
either DK_CM_USER_KIND_USER or DK_CM_USER_KIND_GROUP or DK_CM_USER_KIND_PUBLIC

setPatronType

public void setPatronType(short type)
Sets the patron type of this pbject
Parameters:
type - either DK_CM_USER_KIND_USER or DK_CM_USER_KIND_GROUP or DK_CM_USER_KIND_PUBLIC

isUser

public boolean isUser()
Gets the patron type associated with this object.
Returns:
true if this object represents a user.

isGroup

public boolean isGroup()
Gets the patron type associated with this object.
Returns:
true if this object represents a user group.

EIP Java APIs

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