com.ibm.itim.dataservices.model

Class EntityLifecycleProfile

java.lang.Object

com.ibm.itim.dataservices.model.EntityLifecycleProfile

All Implemented Interfaces:

ManagableProfile

public class EntityLifecycleProfile
extends java.lang.Object
implements ManagableProfile

This class implements the ManagableProfile interface for entities themselves. This class will only be used by entities which have lifecycle operations defined at the instance level vs. at the ObjectProfile level. Only the operations defined at the instance level will be available through this class. Any that are not defined at the instance level, but defined at the profile level must be obtained from the ObjectProfile directly.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LIFECYCLE_ATTR_OPERATION String constant for the operation xml.
static java.lang.String	LIFECYCLE_ATTR_TARGET String constant for the entity target attribute.

Constructor Summary

Constructors

Constructor and Description
EntityLifecycleProfile(java.util.Collection operations) Constructs the entity lifecycle profile with parameters.

Method Summary

Modifier and Type	Method and Description
void	addOperation(ObjectProfileOperation operation) Adds a new operation to the list of supported operations for the entity.
void	addRule(LifecycleRule rule) Adds a new lifecycle rule to the list of supported lifecycle rules for the profile
DistinguishedName	getDistinguishedName() Returns the distinguished name of the entity.
DistinguishedName	getEntityTarget() Returns the distinguished name of the entity that the profile is defined for.
java.lang.String	getName() Returns the name of the object
ObjectProfileOperation	getOperation(java.lang.String name) Returns a specific operation by name.
java.util.Collection	getOperationNames() Returns the supported operations for the entity
java.util.Collection	getOperations() Returns the supported operations for the entity.
LifecycleRule	getRule(long ruleID) Returns the supported lifecycle rules for the profile for a given id.
java.util.Collection	getRules() Returns the supported lifecycle rules for the profile
void	removeOperation(java.lang.String operationName) Removes an operation from the list of supported operations.
void	removeRule(long ruleID) Removes the supported rules for the profile
void	setOperation(ObjectProfileOperation oper) Modifies a specific operation by name.
void	setOperations(java.util.Collection operations) Sets the supported operations for the entity.
void	setRule(LifecycleRule rule) Sets the supported rule for the profile.
void	setRules(java.util.Collection rules) Sets the supported rules for the profile.

Methods inherited from class java.lang.Object

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

Field Detail

LIFECYCLE_ATTR_OPERATION

public static java.lang.String LIFECYCLE_ATTR_OPERATION

String constant for the operation xml.

LIFECYCLE_ATTR_TARGET

public static java.lang.String LIFECYCLE_ATTR_TARGET

String constant for the entity target attribute.

Constructor Detail

EntityLifecycleProfile

public EntityLifecycleProfile(java.util.Collection operations)

Constructs the entity lifecycle profile with parameters.

Parameters:

operations - Collection of ObjectProfileOperations.

Method Detail

getName

public java.lang.String getName()

Returns the name of the object

Specified by:

getName in interface ManagableProfile

Returns:

String name of the object

getDistinguishedName

public DistinguishedName getDistinguishedName()

Returns the distinguished name of the entity.

Specified by:

getDistinguishedName in interface ManagableProfile

Returns:

DistinguishedName of the entity.

getEntityTarget

public DistinguishedName getEntityTarget()

Returns the distinguished name of the entity that the profile is defined for.

Returns:

DistinguishedName of the entity.

getOperations

public java.util.Collection getOperations()

Returns the supported operations for the entity.

Specified by:

getOperations in interface ManagableProfile

Returns:

Collection of ObjectProfileOperations.

getOperationNames

public java.util.Collection getOperationNames()

Returns the supported operations for the entity

Specified by:

getOperationNames in interface ManagableProfile

Returns:

Collection of operation names (Strings).

getOperation

public ObjectProfileOperation getOperation(java.lang.String name)

Returns a specific operation by name.

Specified by:

getOperation in interface ManagableProfile

Parameters:

name - The name of the operation.

Returns:

ObjectProfileOperation with the given name, null if none found.

setOperations

public void setOperations(java.util.Collection operations)
                   throws java.lang.ClassCastException

Sets the supported operations for the entity.

Specified by:

setOperations in interface ManagableProfile

Parameters:

operations - Collection of supported ObjectProfileOperations.

Throws:

java.lang.ClassCastException

addOperation

public void addOperation(ObjectProfileOperation operation)

Adds a new operation to the list of supported operations for the entity.

Specified by:

addOperation in interface ManagableProfile

Parameters:

operation - ObjectProfileOperation to add.

setOperation

public void setOperation(ObjectProfileOperation oper)
                  throws ObjectNotFoundException

Modifies a specific operation by name.

Specified by:

setOperation in interface ManagableProfile

Parameters:

oper - ObjectProfileOperation to modify.

Throws:

ObjectNotFoundException - Thrown if operation is not currently in the profile.

removeOperation

public void removeOperation(java.lang.String operationName)
                     throws ObjectNotFoundException,
                            ModelException

Removes an operation from the list of supported operations.

Specified by:

removeOperation in interface ManagableProfile

Parameters:

operationName - Name of the operation to remove.

Throws:

ObjectNotFoundException - Thrown if operation with name is not currently in the profile.

ModelException - Thrown if unable to remove the operation.

getRules

public java.util.Collection getRules()

Returns the supported lifecycle rules for the profile

Specified by:

getRules in interface ManagableProfile

Returns:

Collection of LifecycleRule

setRules

public void setRules(java.util.Collection rules)
              throws java.lang.ClassCastException

Sets the supported rules for the profile. A new identification number is generated for all lifecycle rules.

Specified by:

setRules in interface ManagableProfile

Parameters:

rules - Collection of supported LifecycleRule

Throws:

java.lang.ClassCastException

setRule

public void setRule(LifecycleRule rule)

Sets the supported rule for the profile.

Specified by:

setRule in interface ManagableProfile

Parameters:

rule - A modified lifecycle rule.

getRule

public LifecycleRule getRule(long ruleID)

Returns the supported lifecycle rules for the profile for a given id.

Specified by:

getRule in interface ManagableProfile

Parameters:

ruleID - the identification number of the lifecycle rule. The identification number is obtained from getRules().

Returns:

LifecycleRule lifecycle rule for a given ruleID.

addRule

public void addRule(LifecycleRule rule)

Adds a new lifecycle rule to the list of supported lifecycle rules for the profile

Specified by:

addRule in interface ManagableProfile

Parameters:

rule - A new lifecycle rule.

removeRule

public void removeRule(long ruleID)
                throws ObjectNotFoundException

Removes the supported rules for the profile

Specified by:

removeRule in interface ManagableProfile

Parameters:

ruleID - identifier of supported LifecycleRule

Throws:

ObjectNotFoundException - Thrown if unable to locate the lifecycle rule.