com.ibm.itim.apps.policy
Class ProvisioningPolicy

java.lang.Object
  extended by com.ibm.itim.dataservices.model.DirectoryEntry
      extended by com.ibm.itim.dataservices.model.DirectoryObject
          extended by com.ibm.itim.apps.policy.ProvisioningPolicy
All Implemented Interfaces:
ProtectedObject, com.ibm.itim.util.Sortable, com.ibm.itim.util.xml.objectstream.Importable, java.io.Serializable

public class ProvisioningPolicy
extends DirectoryObject
implements java.io.Serializable

This class is the value object for the provisioning policy. It is a transfer-object for provisioning policy .

See Also:
Serialized Form

Field Summary
static int ONELEVEL_SCOPE
          Policy single scope of the same level target as policy container
static java.lang.String POLICY_ATTR_CAPTION
          String constant for label attribute name
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_KEY_WORDS
          String constant for keywords attribute name
static java.lang.String POLICY_ATTR_NAME
          String constant for name attribute name
static java.lang.String POLICY_ATTR_REQ_POLICY_TARGET
          String constant for the required target attribute name
static java.lang.String POLICY_ATTR_SCOPE
          String constant for the scope attribute name
static java.lang.String PROVISIONING_POLICY_ATTR_ENTITLEMENTS
          String constant for the entitlement attribute name.
static java.lang.String PROVISIONING_POLICY_ATTR_MEMBERSHIP
          String constant for the membership attribute name.
static java.lang.String PROVISIONING_POLICY_ATTR_PRIORITY
          String constant for the priority attribute name.
static int SUBTREE_SCOPE
          Policy subtree scope of the same level or subtree target as policy container
 
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
ProvisioningPolicy()
          The default constructor.
ProvisioningPolicy(java.lang.String name, java.lang.String caption, java.lang.String description, java.lang.String keywords, boolean enabled, int scope, int priority, java.util.Collection memberships, java.util.Collection entitlements)
          The constructor with full set of parameters necessary for a construction of a complete provisioning policy
 
Method Summary
 java.lang.String getCaption()
          Returns the value of the caption attribute in the policy.
 java.lang.String getDescription()
          Returns the value of the description attribute in the policy.
 java.util.Collection getEntitlements()
          Returns the value of the entitlements.
 java.lang.String getKeywords()
          Returns the value of the keywords attribute in the policy.
 java.util.Collection getMemberships()
          Returns the value of the memberships.
 java.lang.String getName()
          Returns the value of the name attribute of the policy.
 int getPriority()
          Returns the value of the priority attribute in the policy.
 int getScope()
          Returns the value of the scope attribute in the policy.
 boolean isDraft()
          Determines whether the policy is a "draft" policy.
 boolean isEnabled()
          Returns the value of the enabled attribute in the policy.
 void setCaption(java.lang.String caption)
          Sets the value of the caption attribute in the policy.
 void setDescription(java.lang.String description)
          Sets the value of the description attribute in the policy.
 void setEnabled(boolean enabled)
          Sets the value of the enabled attribute in the policy.
 void setEntitlements(java.util.Collection entitlements)
          Sets the value of the entitlements.
 void setKeywords(java.lang.String keywords)
          Sets the value of the keywords attribute in the policy.
 void setMemberships(java.util.Collection memberships)
          Sets the value of the memberships.
 void setName(java.lang.String name)
          Sets the value of the name attribute of the policy.
 void setPriority(int priority)
          Sets the value of the priority attribute in the policy
 void setScope(int scope)
          Sets the value of the scope attribute in the policy.
 
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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

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_KEY_WORDS

public static final java.lang.String POLICY_ATTR_KEY_WORDS
String constant for keywords attribute name

See Also:
Constant Field Values

POLICY_ATTR_CAPTION

public static final java.lang.String POLICY_ATTR_CAPTION
String constant for label 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_ENABLED

public static final java.lang.String POLICY_ATTR_ENABLED
String constant for enabled attribute name

See Also:
Constant Field Values

ONELEVEL_SCOPE

public static final int ONELEVEL_SCOPE
Policy single scope of the same level target as policy container


SUBTREE_SCOPE

public static final int SUBTREE_SCOPE
Policy subtree scope of the same level or subtree target as policy container


POLICY_ATTR_SCOPE

public static final java.lang.String POLICY_ATTR_SCOPE
String constant for the scope attribute name

See Also:
Constant Field Values

PROVISIONING_POLICY_ATTR_ENTITLEMENTS

public static final java.lang.String PROVISIONING_POLICY_ATTR_ENTITLEMENTS
String constant for the entitlement attribute name.

See Also:
Constant Field Values

PROVISIONING_POLICY_ATTR_PRIORITY

public static final java.lang.String PROVISIONING_POLICY_ATTR_PRIORITY
String constant for the priority attribute name.

See Also:
Constant Field Values

PROVISIONING_POLICY_ATTR_MEMBERSHIP

public static final java.lang.String PROVISIONING_POLICY_ATTR_MEMBERSHIP
String constant for the membership attribute name.

See Also:
Constant Field Values

POLICY_ATTR_REQ_POLICY_TARGET

public static final java.lang.String POLICY_ATTR_REQ_POLICY_TARGET
String constant for the required target attribute name

See Also:
Constant Field Values
Constructor Detail

ProvisioningPolicy

public ProvisioningPolicy()
The default constructor.


ProvisioningPolicy

public ProvisioningPolicy(java.lang.String name,
                          java.lang.String caption,
                          java.lang.String description,
                          java.lang.String keywords,
                          boolean enabled,
                          int scope,
                          int priority,
                          java.util.Collection memberships,
                          java.util.Collection entitlements)
The constructor with full set of parameters necessary for a construction of a complete provisioning policy

Parameters:
name - The policy name
caption - The policy caption
description - The policy description
keywords - The policy keywords
enabled - The policy status
scope - The policy scope
priority - The policy priority
memberships - A list of Membership objects
entitlements - A list of Entitlement objects
Method Detail

getEntitlements

public java.util.Collection getEntitlements()
Returns the value of the entitlements. The value if any will be in the form of a Collection of Entitlement object, empty Collection if there is no entitlement.

Returns:
the current Collection value of the entitlements .

setEntitlements

public void setEntitlements(java.util.Collection entitlements)
Sets the value of the entitlements. This value is expected to be a Collection of Entitlement object

Parameters:
entitlements - The new value of the entitlements .

getMemberships

public java.util.Collection getMemberships()
Returns the value of the memberships. The value if any will be in the form of a Collection of Membership object; empty Collection if there is no membership.

Returns:
the current value of the entitlements .

setMemberships

public void setMemberships(java.util.Collection memberships)
Sets the value of the memberships. This value is expected to be a Collection of Membership object.

Parameters:
memberships - the new value of the memberships .

getName

public java.lang.String getName()
Returns the value of the name attribute of the policy.

Overrides:
getName in class DirectoryObject
Returns:
the current value of the name attribute of the policy.

setName

public void setName(java.lang.String name)
Sets the value of the name attribute of the policy.

Parameters:
name - The new value of the name attribute.

getKeywords

public java.lang.String getKeywords()
Returns the value of the keywords attribute in the policy.

Returns:
the current value of the keywords attribute.

setKeywords

public void setKeywords(java.lang.String keywords)
Sets the value of the keywords attribute in the policy.

Parameters:
keywords - The new value of the keywords attribute

getCaption

public java.lang.String getCaption()
Returns the value of the caption attribute in the policy.

Returns:
The current value of the caption attribute

setCaption

public void setCaption(java.lang.String caption)
Sets the value of the caption attribute in the policy.

Parameters:
caption - The new value of the caption attribute

getDescription

public java.lang.String getDescription()
Returns the value of the description attribute in the policy.

Returns:
The current value of the description attribute

setDescription

public void setDescription(java.lang.String description)
Sets the value of the description attribute in the policy.

Parameters:
description - the new value of the description attribute

isEnabled

public boolean isEnabled()
Returns the value of the enabled attribute in the policy.

Returns:
The current value of the enabled attribute.

setEnabled

public void setEnabled(boolean enabled)
Sets the value of the enabled attribute in the policy.

Parameters:
enabled - The new boolean value of the enabled attribute.

isDraft

public boolean isDraft()
Determines whether the policy is a "draft" policy.

Returns:
true if the policy is a "draft" policy, else false.
Since:
ITIM 4.6

getScope

public int getScope()
Returns the value of the scope attribute in the policy.

Returns:
The current value of the scope attribute

setScope

public void setScope(int scope)
Sets the value of the scope attribute in the policy. Possible values are ONELEVEL_SCOPE or SUBTREE_SCOPE.

Parameters:
scope - The new value of the scope attribute

getPriority

public int getPriority()
Returns the value of the priority attribute in the policy.

Returns:
The current value of the priority attribute.

setPriority

public void setPriority(int priority)
Sets the value of the priority attribute in the policy

Parameters:
priority - The new value of the priority attribute


IBM Security Identity Manager 6.0.0
© Copyright International Business Machines Corporation 2007, 2012. All rights reserved. US Government Users Restricited Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.