org.tigris.scarab.om
Class Transition

java.lang.Object
  org.apache.torque.om.BaseObject
      org.tigris.scarab.om.BaseTransition
          org.tigris.scarab.om.Transition

All Implemented Interfaces:

Conditioned, org.apache.torque.om.Persistent, org.apache.fulcrum.intake.Retrievable, java.io.Serializable

public class Transition

extends BaseTransition

implements org.apache.torque.om.Persistent, Conditioned

Every transition declare the ability of a role to change the value of an attribute from one of its options to another.

Author:

Diego Martinez Velasco, Jorge Uriarte Aretxaga

See Also:

CheapWorkflow, Serialized Form

Field Summary

Fields inherited from class org.tigris.scarab.om.BaseTransition

collConditions

Fields inherited from class org.apache.torque.om.BaseObject

NEW_ID

Constructor Summary

Transition()

Method Summary

java.util.List	getConditions() Returns the conditions associated to this Transition
java.lang.Integer[]	getConditionsArray() Returns the array of attributeOptionIds that will force the requiment of this attribute if set.
AttributeOption	getFrom()
java.lang.String	getFromName()
org.apache.fulcrum.security.entity.Role	getRole()
java.lang.String	getRoleName()
AttributeOption	getTo()
java.lang.String	getToName()
boolean	isConditioned()
boolean	isRequiredIf(java.lang.Integer optionID) Return true if the given attributeOptionId will make the current attribute required.
void	setConditionsArray(java.lang.Integer[] aOptionId) Load the attribute options' IDs from the template combo.
java.lang.String	toString()

Methods inherited from class org.tigris.scarab.om.BaseTransition

addCondition, copy, copyInto, getAttribute, getAttribute, getAttributeId, getAttributeOptionRelatedByFromOptionId, getAttributeOptionRelatedByFromOptionId, getAttributeOptionRelatedByToOptionId, getAttributeOptionRelatedByToOptionId, getByName, getByPeerName, getByPosition, getConditions, getConditions, getConditions, getConditionsJoinAttribute, getConditionsJoinAttributeOption, getConditionsJoinRModuleAttribute, getConditionsJoinRModuleIssueType, getConditionsJoinTransition, getDisabledIfBlocked, getFieldNames, getFromOptionId, getPeer, getPrimaryKey, getQueryKey, getRoleId, getToOptionId, getTransitionId, initConditions, isCacheOnSave, save, save, save, setAttribute, setAttributeId, setAttributeKey, setAttributeOptionRelatedByFromOptionId, setAttributeOptionRelatedByFromOptionIdKey, setAttributeOptionRelatedByToOptionId, setAttributeOptionRelatedByToOptionIdKey, setDisabledIfBlocked, setFromOptionId, setPrimaryKey, setPrimaryKey, setQueryKey, setRoleId, setToOptionId, setTransitionId

Methods inherited from class org.apache.torque.om.BaseObject

equals, equals, getLog, hashCode, isModified, isNew, resetModified, setModified, setNew, setPrimaryKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.torque.om.Persistent

getPrimaryKey, isModified, isNew, save, save, save, setModified, setNew, setPrimaryKey, setPrimaryKey

Constructor Detail

Transition

public Transition()

Method Detail

getRole

public org.apache.fulcrum.security.entity.Role getRole()

getFrom

public AttributeOption getFrom()

getTo

public AttributeOption getTo()

isRequiredIf

public boolean isRequiredIf(java.lang.Integer optionID)
                     throws org.apache.torque.TorqueException

Description copied from interface: Conditioned

Return true if the given attributeOptionId will make the current attribute required.

Specified by:

isRequiredIf in interface Conditioned

Parameters:

optionID -

Returns:

Throws:

org.apache.torque.TorqueException

getFromName

public java.lang.String getFromName()

getToName

public java.lang.String getToName()

getRoleName

public java.lang.String getRoleName()

getConditions

public java.util.List getConditions()
                             throws org.apache.torque.TorqueException

Returns the conditions associated to this Transition

Overrides:

getConditions in class BaseTransition

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getConditionsArray

public java.lang.Integer[] getConditionsArray()

Returns the array of attributeOptionIds that will force the requiment of this attribute if set. Used by templates to load the combo.

Specified by:

getConditionsArray in interface Conditioned

Returns:

setConditionsArray

public void setConditionsArray(java.lang.Integer[] aOptionId)
                        throws org.apache.torque.TorqueException

Load the attribute options' IDs from the template combo.

Specified by:

setConditionsArray in interface Conditioned

Parameters:

aOptionId -

Throws:

org.apache.torque.TorqueException

isConditioned

public boolean isConditioned()

Specified by:

isConditioned in interface Conditioned

Returns:

true if there's any condition associated to this object, false if there's not.

toString

public java.lang.String toString()

Overrides:

toString in class BaseTransition