com.ibm.itim.apps.policy
Class Entitlement

java.lang.Object
  com.ibm.itim.apps.policy.Entitlement

All Implemented Interfaces:

java.io.Serializable

public class Entitlement
extends java.lang.Object
implements java.io.Serializable

This class represents an entitlement of a provisioning policy. An entitlement is defined by a type (manual or automatic), a target, a set of optional provisioning parameters defined inline with the entitlement, and an optional workflow process to be followed.

See Also:

ProvisioningPolicy, Serialized Form

Field Summary

static java.lang.String	ALL_OWNERSHIP_TYPE Constant String indicating all ownership types
static int	ENTITLEMENT_TYPE_AUTHORIZED Entitlement type indicating manual account creation
static int	ENTITLEMENT_TYPE_REQUIRED Entitlement type indicating automatic account creation

Constructor Summary

Entitlement()
The default constructor.

Entitlement(int type, ServiceTarget target, ProvisioningParameters parameters, DistinguishedName processDN)
The entitlement constructor with full set of parameters.

Entitlement(int type, ServiceTarget target, ProvisioningParameters parameters, DistinguishedName processDN, java.lang.String ownershipType)
The entitlement constructor with full set of parameters.

Method Summary

boolean	equals(java.lang.Object entitlement) Compares this entitlement against the entitlement object passed in.
java.lang.String	getOwnershipType() Returns the ownership type value.
DistinguishedName	getProcessDN() Returns the current DistinguishedName value of the workflow process associated with this entitlement.
ProvisioningParameters	getProvisioningParameters() Returns the value of the provisioning parameters associated with this entitlement.
ServiceTarget	getTarget() Return the current service target of the entitlement.
int	getType() Returns the entitlement type value.
void	setOwnershipType(java.lang.String ownershipType) Sets the value of the ownership type.
void	setProcessDN(DistinguishedName processDN) Sets the DistinguishedName value of the workflow process to be associated with this entitlement.
void	setProvisioningParameters(ProvisioningParameters parameters) Sets the value of the provisioning parameters of the entitlement.
void	setTarget(ServiceTarget target) Sets the new value of the target property.
void	setType(int type) Sets the value of the Entitlement type.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENTITLEMENT_TYPE_AUTHORIZED

public static final int ENTITLEMENT_TYPE_AUTHORIZED

Entitlement type indicating manual account creation

See Also:

Constant Field Values

ENTITLEMENT_TYPE_REQUIRED

public static final int ENTITLEMENT_TYPE_REQUIRED

Entitlement type indicating automatic account creation

See Also:

Constant Field Values

ALL_OWNERSHIP_TYPE

public static final java.lang.String ALL_OWNERSHIP_TYPE

Constant String indicating all ownership types

See Also:

Constant Field Values

Constructor Detail

Entitlement

public Entitlement()

The default constructor.

Entitlement

public Entitlement(int type,
                   ServiceTarget target,
                   ProvisioningParameters parameters,
                   DistinguishedName processDN)

The entitlement constructor with full set of parameters. This constructor is prefered for a complete Entitlement.

Parameters:

type - The entitlement type. The possible values are ENTITLEMENT_TYPE_AUTHORIZED and ENTITLEMENT_TYPE_REQUIRED.

target - The ServiceTarget object.

parameters - The ProvisioningParameters object.

processDN - The DistinguishedName of the workflow process.

Entitlement

public Entitlement(int type,
                   ServiceTarget target,
                   ProvisioningParameters parameters,
                   DistinguishedName processDN,
                   java.lang.String ownershipType)

The entitlement constructor with full set of parameters. This constructor is prefered for a complete Entitlement.

Parameters:

type - The entitlement type. The possible values are ENTITLEMENT_TYPE_AUTHORIZED and ENTITLEMENT_TYPE_REQUIRED.

target - The ServiceTarget object.

parameters - The ProvisioningParameters object.

processDN - The DistinguishedName of the workflow process.

ownershipType - The ownership type. The possible value can be any specific ownership type configured in the system, or Entitlement.ALL_OWNERSHIP_TYPE.

Method Detail

setTarget

public void setTarget(ServiceTarget target)

Sets the new value of the target property. Care must be taken when using this method to set a new ServiceTarget of different service type as the new service type can cause the parameters to be out of synch with this new service type. If setting a new ServiceTarget of a different service type than the old one, user should reset the ProvisioningParameters also.

Parameters:

target - The new ServiceTarget for this entitlement.

getTarget

public ServiceTarget getTarget()

Return the current service target of the entitlement.

Returns:

ServiceTarget of the current target property. NULL if not exist.

setProcessDN

public void setProcessDN(DistinguishedName processDN)

Sets the DistinguishedName value of the workflow process to be associated with this entitlement.

Parameters:

processDN - The new DistinguishedName value of the workflow process.

getProcessDN

public DistinguishedName getProcessDN()

Returns the current DistinguishedName value of the workflow process associated with this entitlement.

Returns:

DistinguishedName value of the workflow process.

setType

public void setType(int type)

Sets the value of the Entitlement type. The possible values are ENTITLEMENT_TYPE_AUTHORIZED and ENTITLEMENT_TYPE_REQUIRED

Parameters:

type - The entitlement type.

getType

public int getType()

Returns the entitlement type value. The possible values are ENTITLEMENT_TYPE_AUTHORIZED and ENTITLEMENT_TYPE_REQUIRED.

Returns:

the current value of the entitlement type.

getProvisioningParameters

public ProvisioningParameters getProvisioningParameters()

Returns the value of the provisioning parameters associated with this entitlement.

Returns:

the ProvisioningParameters object of the entitlement.

setProvisioningParameters

public void setProvisioningParameters(ProvisioningParameters parameters)

Sets the value of the provisioning parameters of the entitlement.

Parameters:

parameters - The new ProvisioningParameters object.

equals

public boolean equals(java.lang.Object entitlement)

Compares this entitlement against the entitlement object passed in.

Overrides:

equals in class java.lang.Object

Parameters:

entitlement - The object to be compared

Returns:

true if the passing object is the same as this entitlement, false otherwise

setOwnershipType

public void setOwnershipType(java.lang.String ownershipType)

Sets the value of the ownership type. The possible value can be any specific ownership type configured in the system, or Entitlement.ALL_OWNERSHIP_TYPE.

Parameters:

ownershipType - The ownership type.

getOwnershipType

public java.lang.String getOwnershipType()

Returns the ownership type value. The possible value can be any specific ownership type configured in the system, or Entitlement.ALL_OWNERSHIP_TYPE.

Returns:

the current value of the ownership type.