com.bea.wlpi.common
Class TemplateDefinitionInfo

java.lang.Object
  |
  +--com.bea.wlpi.common.TemplateDefinitionInfo

public final class TemplateDefinitionInfo

extends java.lang.Object

implements java.io.Serializable, java.lang.Comparable

Holds information about a workflow template definition.

Objects of this class override the boolean equals(Object) and implement the comparable interface. Homogeneous collections containing objects of this class may, therefore, be searched and sorted using the Collection.contains(Object), List.indexOf(Object), Collections.sort(List) methods.

See Also:

Serialized Form

Constructor Summary

TemplateDefinitionInfo(java.lang.String id, java.sql.Timestamp effective, java.sql.Timestamp expiry, boolean active)
Create a new TemplateDefinitionInfo object.

Method Summary

int	compareTo(java.lang.Object o) Compare two TemplateDefinitionInfo objects.
boolean	equals(java.lang.Object obj) Test two TemplateDefinitionInfo objects for equality.
boolean	getActive() Return whether the definition is marked as active.
java.sql.Timestamp	getEffective() Return the effective date for the definition.
java.sql.Timestamp	getExpiry() Return the expiry date for the definition.
java.lang.String	getId() Return the template definition ID.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemplateDefinitionInfo

public TemplateDefinitionInfo(java.lang.String id,
                              java.sql.Timestamp effective,
                              java.sql.Timestamp expiry,
                              boolean active)

Create a new TemplateDefinitionInfo object.

Parameters:

id - Template definition ID.

effective - The date/time on which the definition becomes effective.

expiry - The date/time on which the definition expires.

active - true if definition is active (i.e., can be instantiated).

Method Detail

getId

public final java.lang.String getId()

Return the template definition ID.

Returns:

The template definition ID as set by the constructor.

getEffective

public final java.sql.Timestamp getEffective()

Return the effective date for the definition.

Returns:

The effective date as set by the constructor.

getExpiry

public final java.sql.Timestamp getExpiry()

Return the expiry date for the definition.

Returns:

The expiry date as set by the constructor.

getActive

public final boolean getActive()

Return whether the definition is marked as active.

Returns:

The active flag as set by the constructor.

equals

public boolean equals(java.lang.Object obj)

Test two TemplateDefinitionInfo objects for equality.

Overrides:

equals in class java.lang.Object

Parameters:

obj - Object with which to compare this one.

Returns:

true if obj is an instance of TemplateDefinitionInfo with the same ID as this one.

See Also:

compareTo(java.lang.Object)

compareTo

public int compareTo(java.lang.Object o)

Compare two TemplateDefinitionInfo objects.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - Object with which to compare this one. Must be null or an instance of TemplateDefinitionInfo.

Returns:

The result of comparing the effective members using the Date.compareTo(Object) method.

Throws:

java.lang.ClassCastException - if o is not an instance of TemplateDefinitionInfo.

See Also:

equals(java.lang.Object)