EntitlementInProvisioningPolicy

java.lang.Object
- com.ibm.itim.policy.EntitlementInProvisioningPolicy

All Implemented Interfaces:

java.io.Serializable

com.ibm.itim.policy.SortableByPriority
```
public class EntitlementInProvisioningPolicy
implements java.io.Serializable , com.ibm.itim.policy.SortableByPriority
```
This class holds information about an entitlement and its parent - the provisioning policy. It containins a specific implementation of compareTo method, which makes it possible for the objects of this class to be sorted by priority when for example inserted in to a TreeSet. This class is used during poilcy join operations.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`EntitlementInProvisioningPolicy()` The default constructor.
`EntitlementInProvisioningPolicy( ProvisioningPolicyEntity policy, Entitlement entitlement)`
`EntitlementInProvisioningPolicy( ProvisioningPolicyEntity policy, Entitlement entitlement, DistinguishedName policyDN, java.lang.String policyName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object entitlement)` Compares this entitlement against the entitlement object passed in.
`int`	`hashCode()` Answers an integer hash code for the receiver. Any two objects which answer true when passed to .equals must answer the same value.
`int`	`compareTo()` Method performs a comparison of two EntitlementInProvisioningPolicy objects
`java.lang.Object`	`clone()` Returns the object clone of EntitlementInProvisioningPolicy object
`java.lang.String`	`getPolicyName()` Returns the Policy name value.
`DistinguishedName`	`getPolicyDN()` Returns the current DistinguishedName value of the policy associated with this EntitlementInProvisioningPolicy.
`ProvisioningPolicyEntity`	`ProvisioningPolicyEntity()` Returns the ProvisioningPolicyEntity object.
`Entitlement`	`Entitlement()` Returns the entitlement associated with this object.
`void`	`setPolicy(ProvisioningPolicyEntity policy)` Sets the provisioning policy associated with this object.
`void`	`setEntitlement(Entitlement entitlement)` Sets the entitlement associated with this objec.

Methods inherited from class java.lang.Object
hashCode,clone,equals,compareTo

Constructor Detail
- EntitlementInProvisioningPolicy
```
public EntitlementInProvisioningPolicy()
```
  The default constructor.
- EntitlementInProvisioningPolicy
```
public EntitlementInProvisioningPolicy(
                  ProvisioningPolicyEntity policy,
                  Entitlement entitlement)
```
  The EntitlementInProvisioningPolicy constructor with full set of policy. This constructor is prefered for a complete EntitlementInProvisioningPolicy.
  
  Parameters:
  
  policy - The ProvisioningPolicyEntity object.
  
  entitlement - The entitlement of a provisioning policy.
- EntitlementInProvisioningPolicy
```
public EntitlementInProvisioningPolicy(
            ProvisioningPolicyEntity policy,
           Entitlement entitlement,
           DistinguishedName policyDN,
           java.lang.String policyName)
```
  The EntitlementInProvisioningPolicy constructor with full set of policy. This constructor is prefered for a complete EntitlementInProvisioningPolicy.
  
  Parameters:
  
  policy - The ProvisioningPolicyEntity object.
  
  entitlement - The entitlement of a provisioning policy.
  
  policyDN - The DistinguishedName of the provisioning policy.
  
  policyName - The policcy name. The possible value can be any specific policy name configured in the system.

Method Detail
- setPolicy
```
public void setPolicy(ProvisioningPolicyEntity policy)
```
  Sets the provisioning policy associated with this object. The provided ProvisioningPolicyEntity is assigned to the policy attribute.
  
  Parameters:
  
  policy - The ProvisioningPolicyEntity object.
- getPolicy
```
public ProvisioningPolicyEntity getPolicy()
```
  Return the associated provisioning policy. If the policy is not already set, it performs a lookup using the policyDN field.
  
  Returns:
  
  provisioning policy of the current target property. NULL if not exist.
- getPolicyDN
```
public DistinguishedName getPolicyDN()
```
  Returns the distinguished name (policyDN) of the associated provisioning policy. This uniquely identifies the policy within the system.
  
  Returns:
  
  DistinguishedName value of the associated provisioning policy.
- setEntitlement
```
public void setEntitlement(Entitlement entitlement)
```
  Sets the entitlement associated with this object. The provided Entitlement is assigned to the entitlement attribute.
  
  Parameters:
  
  entitlement - The entitlement of a provisioning policy.
- getEntitlement
```
public Entitlement getEntitlement()
```
  return the entitlement associated with this object. The provided Entitlement is assigned to the entitlement attribute.
  
  Returns:
  
  The entitlement of a provisioning policy.
- getPolicyName
```
public String getPolicyName()
```
  Returns the name of the associated provisioning policy. This provides the name stored in the policyName attribute.
  
  Returns:
  
  the current value of the provisioning policy.
- equals
```
public boolean equals(java.lang.Object obj)
```
  Compares this entitlement against the entitlement object passed in.
  
  Overrides:
  
  equals in class java.lang.Object
  
  Parameters:
  
  obj - The object to be compared
  
  Returns:
  
  true if the passing object is the same as this provisioning policy, false otherwise
- hashCode
```
public int hashCode()
```
  The hashCode() method generates a hash code for the EntitlementInProvisioningPolicy object .
  
  Returns:
  
  return the hashcode
- clone
```
public Object clone()
```
  Return a shallow copy of the EntitlementInProvisioningPolicy object. Only the entitlement is deeply cloned, while the policy is shared between the original and the cloned object.
  
  Returns:
  
  Return object clone of this EntitlementInProvisioningPolicy object
- compareTo
```
public int compareTo(java.lang.Object obj)
```
  The compareTo() method compares two EntitlementInProvisioningPolicy objects based on the priority of their associated provisioning policies. It returns a value indicating which object has a higher, lower, or equal priority.
  
  Returns:
  
  1: If the current object's priority is higher.
  
  -1: If the current object's priority is lower.
  
  0: If both objects have the same priority.