com.ibm.itim.dataservices.model
Class LifecycleRule

java.lang.Object
  com.ibm.itim.dataservices.model.LifecycleRule

All Implemented Interfaces:

com.ibm.itim.util.Sortable, java.io.Serializable

public class LifecycleRule
extends java.lang.Object
implements com.ibm.itim.util.Sortable, java.io.Serializable

Class that represents a lifecycle rule associated with an object profile. The lifecycle rule is defined by a filter that identifies the entities the rule applies to, a schedule of how oftern to evaluate the rule, and an operation to execute to implement the rule. The operation is a reference only to an operation defined for the same object profile the rule is defined for.

See Also:

Serialized Form

Field Summary

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

ATTR_NAME

Constructor Summary

LifecycleRule()
Constructs a new lifecycle rule.

LifecycleRule(java.lang.String xml)
Constructs a new lifecycle rule.

LifecycleRule(java.lang.String name, java.lang.String operation)
Constructs a new lifecycle rule.

Method Summary

java.lang.String	getDescription() Returns the description of the lifecycle rule.
java.lang.String	getFilter() Returns the filter identifying the entities governed by the lifeycle rule.
long	getID() Returns the identifier of the lifecycle rule.
java.lang.String	getName() Returns the name of the lifecycle rule.
java.lang.String	getObjProfileOperationDN() Returns the DN of the object profile operation executed by the lifecycle rule.
java.lang.String	getOperation() Returns the name of the operation executed by the lifecycle rule.
java.lang.Object	getSortValue(java.lang.String attributeName)
boolean	isLaunchAsRoot() Returns the LaunchAsRoot property of the lifecycle rule.
java.lang.String	objectToXML() Converts the content of the lifecycle rule to an XML string.
void	setDescription(java.lang.String description) Changes the description of the lifecycle rule.
void	setFilter(java.lang.String filter) Changes the filter identifying the entities governed by the lifecycle rule.
void	setLaunchAsRoot(boolean isLaunchAsRoot) Changes the LaunchAsRoot property of the lifecycle rule.
void	setName(java.lang.String name) Changes the name of the lifecycle rule.
void	setObjProfileOperationDN(java.lang.String dn) Changes the DN of the object profile operation executed by the lifecycle rule.
void	setOperation(java.lang.String operation) Changes the name of the operation executed by the lifecycle rule.
java.lang.String	toString()
java.lang.String	toXML() Returns an XML String representation of the attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

LifecycleRule

public LifecycleRule()

Constructs a new lifecycle rule.

LifecycleRule

public LifecycleRule(java.lang.String xml)

Constructs a new lifecycle rule.

Parameters:

xml - XML string represent the lifecycle rule.

LifecycleRule

public LifecycleRule(java.lang.String name,
                     java.lang.String operation)

Constructs a new lifecycle rule.

Parameters:

name - name of the lifecycle rule.

operation - operation name of the lifecycle rule.

Method Detail

getID

public long getID()

Returns the identifier of the lifecycle rule.

Returns:

identifier of the lifecycle rule.

getName

public java.lang.String getName()

Returns the name of the lifecycle rule.

Returns:

Name of the lifecycle rule.

setName

public void setName(java.lang.String name)

Changes the name of the lifecycle rule.

Parameters:

name - Name of the lifecycle rule.

getFilter

public java.lang.String getFilter()

Returns the filter identifying the entities governed by the lifeycle rule.

Returns:

String representation of the entity filter.

setFilter

public void setFilter(java.lang.String filter)

Changes the filter identifying the entities governed by the lifecycle rule.

Parameters:

filter - String representation of the entity filter.

getDescription

public java.lang.String getDescription()

Returns the description of the lifecycle rule.

Returns:

String description of the lifecycle rule.

setDescription

public void setDescription(java.lang.String description)

Changes the description of the lifecycle rule.

Parameters:

description - description of the lifecycle rule.

getOperation

public java.lang.String getOperation()

Returns the name of the operation executed by the lifecycle rule.

Returns:

Name of the lifecycle rule operation.

setObjProfileOperationDN

public void setObjProfileOperationDN(java.lang.String dn)

Changes the DN of the object profile operation executed by the lifecycle rule.

Parameters:

dn - DN of the lifecycle rule object profile operation to execute.

getObjProfileOperationDN

public java.lang.String getObjProfileOperationDN()

Returns the DN of the object profile operation executed by the lifecycle rule.

Returns:

String of DN pointing to a specific object profile operation

setOperation

public void setOperation(java.lang.String operation)

Changes the name of the operation executed by the lifecycle rule.

Parameters:

operation - Name of the lifecycle rule operation.

isLaunchAsRoot

public boolean isLaunchAsRoot()

Returns the LaunchAsRoot property of the lifecycle rule.

Returns:

LaunchAsRoot property of the lifecycle rule. True if the lifecycle rule is launched as root.

setLaunchAsRoot

public void setLaunchAsRoot(boolean isLaunchAsRoot)

Changes the LaunchAsRoot property of the lifecycle rule.

Parameters:

isLaunchAsRoot - LaunchAsRoot property of the lifecycle rule. True if lifecycle rule is launched as root.

objectToXML

public java.lang.String objectToXML()

Converts the content of the lifecycle rule to an XML string.

Returns:

XML string that represents the lifecycle rule..

toXML

public java.lang.String toXML()

Returns an XML String representation of the attribute.

Returns:

XML String representation of the attribute.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSortValue

public java.lang.Object getSortValue(java.lang.String attributeName)

Specified by:

getSortValue in interface com.ibm.itim.util.Sortable