com.ibm.itim.dataservices.model.pim
Class SharedAccessPolicy

java.lang.Object
  com.ibm.itim.dataservices.model.DirectoryEntry
      com.ibm.itim.dataservices.model.DirectoryObject
          com.ibm.itim.dataservices.model.pim.SharedAccessPolicy

All Implemented Interfaces:

ProtectedObject, com.ibm.itim.util.Sortable, com.ibm.itim.util.xml.objectstream.Importable, java.io.Serializable

public class SharedAccessPolicy
extends DirectoryObject

Value Object class that holds the attribute information of a shared access policy in the data model. The value object does not contain the membership and entitlement information. To get the membership and entitlement information, use SharedAccessPolicyEntity.getMemberships() and SharedAccessPolicyEntity.getEntitlements() instead.

Since:

6.0

See Also:

Serialized Form

Field Summary

static int	ONELEVEL_SCOPE scope of the same level as the target
static java.lang.String	POLICY_ATTR_DESCRIPTION String constant for description attribute name
static java.lang.String	POLICY_ATTR_ENABLED String constant for enabled attribute name
static java.lang.String	POLICY_ATTR_NAME String constant for name attribute name
static java.lang.String	POLICY_ATTR_PARENT_CONTAINER String constant for organizational container name
static java.lang.String	POLICY_ATTR_SCOPE String constant for the scope attribute name
static java.lang.String	POLICY_ATTR_URI String constant for URI attribute name
static java.lang.String	PROFILE_NAME The profile name for shared access policy
static java.lang.String	SHARED_ACCESS_POLICY_ATTR_ENTITLEMENT String constant for the entitlement attribute name
static java.lang.String	SHARED_ACCESS_POLICY_ATTR_MEMBERSHIP String constant for the membership attribute name
static int	SUBTREE_SCOPE scope of the same level as the target or sub tree level if found

Fields inherited from class com.ibm.itim.dataservices.model.DirectoryObject

ATTR_ACCESS_RIGHT, ATTR_LIFECYCLE_ENABLE, ATTR_URI, DESCRIPTION, NAME

Fields inherited from interface com.ibm.itim.util.Sortable

ATTR_NAME

Constructor Summary

SharedAccessPolicy()
The default constructor.

SharedAccessPolicy(AttributeValues attrs)
Constructs object with attribute information.

SharedAccessPolicy(DirectoryObject dirObj)
Copy constructor for directory object

Method Summary

boolean	equals(java.lang.Object policy) Compares the object passed in with itself.
java.lang.String	getDescription() Returns the value of the description attribute.
long	getID() Returns the value of the erglobalid attribute.
java.lang.String	getName() Returns the value of the name attribute.
DistinguishedName	getParentDN() Returns the organizational container DN.
int	getScope() Returns the value of the scope attribute.
int	hashCode() Returns a hash value that can be used in hash tables.
boolean	isEnabled() Returns the value of the enabled attribute.
void	setDescription(java.lang.String aDescription) Sets the value of the description attribute.
void	setEnabled(boolean enabled) Sets the value of the enabled attribute.
void	setName(java.lang.String aName) Sets the value of the name attribute.
void	setScope(int scope) Sets the value of the scope attribute.

Methods inherited from class com.ibm.itim.dataservices.model.DirectoryObject

addAttribute, addAttributeValues, getAccessRights, getAttribute, getAttributes, getAuthorizationOwners, getMapAttributeNames, getMappedAttributes, getNameAttribute, getOldMappedAttributes, getProfileName, getRawAttributes, getSortValue, getTenantDN, isLifecycleDefined, removeAttribute, removeAttribute, setAccessRights, setAttribute, setAttributes, setAuthorizationOwners, setProfileName, setTenantDN, toString

Methods inherited from class com.ibm.itim.dataservices.model.DirectoryEntry

clearChange, clearChanges, getChanges, getDistinguishedName, getLastModified, getObjectClasses, getOldAttributes, setDistinguishedName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

PROFILE_NAME

public static final java.lang.String PROFILE_NAME

The profile name for shared access policy

See Also:

Constant Field Values

POLICY_ATTR_PARENT_CONTAINER

public static java.lang.String POLICY_ATTR_PARENT_CONTAINER

String constant for organizational container name

POLICY_ATTR_NAME

public static final java.lang.String POLICY_ATTR_NAME

String constant for name attribute name

See Also:

Constant Field Values

POLICY_ATTR_DESCRIPTION

public static final java.lang.String POLICY_ATTR_DESCRIPTION

String constant for description attribute name

See Also:

Constant Field Values

POLICY_ATTR_URI

public static final java.lang.String POLICY_ATTR_URI

String constant for URI attribute name

See Also:

Constant Field Values

POLICY_ATTR_ENABLED

public static final java.lang.String POLICY_ATTR_ENABLED

String constant for enabled attribute name

See Also:

Constant Field Values

POLICY_ATTR_SCOPE

public static final java.lang.String POLICY_ATTR_SCOPE

String constant for the scope attribute name

See Also:

Constant Field Values

SHARED_ACCESS_POLICY_ATTR_MEMBERSHIP

public static final java.lang.String SHARED_ACCESS_POLICY_ATTR_MEMBERSHIP

String constant for the membership attribute name

See Also:

Constant Field Values

SHARED_ACCESS_POLICY_ATTR_ENTITLEMENT

public static final java.lang.String SHARED_ACCESS_POLICY_ATTR_ENTITLEMENT

String constant for the entitlement attribute name

See Also:

Constant Field Values

ONELEVEL_SCOPE

public static final int ONELEVEL_SCOPE

scope of the same level as the target

SUBTREE_SCOPE

public static final int SUBTREE_SCOPE

scope of the same level as the target or sub tree level if found

Constructor Detail

SharedAccessPolicy

public SharedAccessPolicy()

The default constructor.

SharedAccessPolicy

public SharedAccessPolicy(AttributeValues attrs)

Constructs object with attribute information. Warning: the purpose of this constructor is to provide clients with the ability to create value objects for creation in the data store. Do not use this constructor to create value objects that represent existing entities. See the SharedAccessPolicySearch object for achieving that.

Parameters:

attrs - AttributeValues holding the attributes of the role.

SharedAccessPolicy

public SharedAccessPolicy(DirectoryObject dirObj)

Copy constructor for directory object

Method Detail

getID

public long getID()

Returns the value of the erglobalid attribute.

Returns:

the current value of the erglobalid attribute .

getName

public java.lang.String getName()

Returns the value of the name attribute.

Overrides:

getName in class DirectoryObject

Returns:

the current value of the name attribute. Empty string when the name attribute is not set.

setName

public void setName(java.lang.String aName)

Sets the value of the name attribute.

Parameters:

aName - the new value of the name attribute.

getDescription

public java.lang.String getDescription()

Returns the value of the description attribute.

Returns:

the current value of the Description attribute, empty string when the description attribute is not set.

setDescription

public void setDescription(java.lang.String aDescription)

Sets the value of the description attribute.

Parameters:

aDescription - the new value of the Description attribute

isEnabled

public boolean isEnabled()

Returns the value of the enabled attribute.

Returns:

the current value of the Enabled attribute.

setEnabled

public void setEnabled(boolean enabled)

Sets the value of the enabled attribute.

Parameters:

enabled - the new boolean value of the Enabled attribute.

getScope

public int getScope()

Returns the value of the scope attribute.

Returns:

the current value of the scope attribute

setScope

public void setScope(int scope)

Sets the value of the scope attribute.

Parameters:

scope - The new value of the scope attribute, must be ONELEVEL_SCOPE or SUBTREE_SCOPE.

getParentDN

public DistinguishedName getParentDN()

Returns the organizational container DN.

Returns:

the DistinguishedName object of the organizational container.

equals

public boolean equals(java.lang.Object policy)

Compares the object passed in with itself.

Overrides:

equals in class java.lang.Object

Parameters:

policy - The object to be compared

Returns:

true if the passing object is the same as self, false otherwise

hashCode

public int hashCode()

Returns a hash value that can be used in hash tables.

Overrides:

hashCode in class java.lang.Object

Returns:

Hash value for the distinguished name.