org.tigris.scarab.om
Class BaseTransition

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Transition

public abstract class BaseTransition

extends org.apache.torque.om.BaseObject

implements org.apache.fulcrum.intake.Retrievable

You should not use this class directly. It should not even be extended all references should be to Transition

See Also:

Serialized Form

Field Summary

protected java.util.List

collConditions Collection to store aggregation of collConditions

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

NEW_ID

Constructor Summary

BaseTransition()

Method Summary

void	addCondition(Condition l) Method called to associate a Condition object to this object through the Condition foreign key attribute
Transition	copy() Makes a copy of this object.
protected Transition	copyInto(Transition copyObj)
Attribute	getAttribute() Returns the associated Attribute object.
Attribute	getAttribute(java.sql.Connection connection) Return the associated Attribute object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.lang.Integer	getAttributeId() Get the AttributeId
AttributeOption	getAttributeOptionRelatedByFromOptionId() Returns the associated AttributeOption object.
AttributeOption	getAttributeOptionRelatedByFromOptionId(java.sql.Connection connection) Return the associated AttributeOption object If it was not retrieved before, the object is retrieved from the database using the passed connection
AttributeOption	getAttributeOptionRelatedByToOptionId() Returns the associated AttributeOption object.
AttributeOption	getAttributeOptionRelatedByToOptionId(java.sql.Connection connection) Return the associated AttributeOption object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.lang.Object	getByName(java.lang.String name) Retrieves a field from the object by name passed in as a String.
java.lang.Object	getByPeerName(java.lang.String name) Retrieves a field from the object by name passed in as a String.
java.lang.Object	getByPosition(int pos) Retrieves a field from the object by Position as specified in the xml schema.
java.util.List	getConditions() If this collection has already been initialized, returns the collection.
java.util.List	getConditions(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getConditions(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getConditions(org.apache.torque.util.Criteria criteria, java.sql.Connection con) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getConditionsJoinAttribute(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getConditionsJoinAttributeOption(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getConditionsJoinRModuleAttribute(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getConditionsJoinRModuleIssueType(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getConditionsJoinTransition(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
boolean	getDisabledIfBlocked() Get the DisabledIfBlocked
static java.util.List	getFieldNames() Generate a list of field names.
java.lang.Integer	getFromOptionId() Get the FromOptionId
TransitionPeer	getPeer() returns a peer instance associated with this om.
org.apache.torque.om.ObjectKey	getPrimaryKey() returns an id that differentiates this object from others of its class.
java.lang.String	getQueryKey() get an id that differentiates this object from others of its class.
java.lang.Integer	getRoleId() Get the RoleId
java.lang.Integer	getToOptionId() Get the ToOptionId
java.lang.Integer	getTransitionId() Get the TransitionId
protected void	initConditions() Temporary storage of collConditions to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected boolean	isCacheOnSave() Specify whether to cache the object after saving to the db.
void	save() Stores the object in the database.
void	save(java.sql.Connection con) Stores the object in the database.
void	save(java.lang.String dbName) Stores the object in the database.
void	setAttribute(Attribute v) Declares an association between this object and a Attribute object
void	setAttributeId(java.lang.Integer v) Set the value of AttributeId
void	setAttributeKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setAttributeOptionRelatedByFromOptionId(AttributeOption v) Declares an association between this object and a AttributeOption object
void	setAttributeOptionRelatedByFromOptionIdKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setAttributeOptionRelatedByToOptionId(AttributeOption v) Declares an association between this object and a AttributeOption object
void	setAttributeOptionRelatedByToOptionIdKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setDisabledIfBlocked(boolean v) Set the value of DisabledIfBlocked
void	setFromOptionId(java.lang.Integer v) Set the value of FromOptionId
void	setPrimaryKey(org.apache.torque.om.ObjectKey key) Set the PrimaryKey using ObjectKey.
void	setPrimaryKey(java.lang.String key) Set the PrimaryKey using a String.
void	setQueryKey(java.lang.String key) set an id that differentiates this object from others of its class.
void	setRoleId(java.lang.Integer v) Set the value of RoleId
void	setToOptionId(java.lang.Integer v) Set the value of ToOptionId
void	setTransitionId(java.lang.Integer v) Set the value of TransitionId
java.lang.String	toString()

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

Field Detail

collConditions

protected java.util.List collConditions

Collection to store aggregation of collConditions

Constructor Detail

BaseTransition

public BaseTransition()

Method Detail

getTransitionId

public java.lang.Integer getTransitionId()

Get the TransitionId

Returns:

Integer

setTransitionId

public void setTransitionId(java.lang.Integer v)
                     throws org.apache.torque.TorqueException

Set the value of TransitionId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getRoleId

public java.lang.Integer getRoleId()

Get the RoleId

Returns:

Integer

setRoleId

public void setRoleId(java.lang.Integer v)

Set the value of RoleId

Parameters:

v - new value

getAttributeId

public java.lang.Integer getAttributeId()

Get the AttributeId

Returns:

Integer

setAttributeId

public void setAttributeId(java.lang.Integer v)
                    throws org.apache.torque.TorqueException

Set the value of AttributeId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getFromOptionId

public java.lang.Integer getFromOptionId()

Get the FromOptionId

Returns:

Integer

setFromOptionId

public void setFromOptionId(java.lang.Integer v)
                     throws org.apache.torque.TorqueException

Set the value of FromOptionId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getToOptionId

public java.lang.Integer getToOptionId()

Get the ToOptionId

Returns:

Integer

setToOptionId

public void setToOptionId(java.lang.Integer v)
                   throws org.apache.torque.TorqueException

Set the value of ToOptionId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getDisabledIfBlocked

public boolean getDisabledIfBlocked()

Get the DisabledIfBlocked

Returns:

boolean

setDisabledIfBlocked

public void setDisabledIfBlocked(boolean v)

Set the value of DisabledIfBlocked

Parameters:

v - new value

setAttribute

public void setAttribute(Attribute v)
                  throws org.apache.torque.TorqueException

Declares an association between this object and a Attribute object

Parameters:

v - Attribute

Throws:

org.apache.torque.TorqueException

getAttribute

public Attribute getAttribute()
                       throws org.apache.torque.TorqueException

Returns the associated Attribute object. If it was not retrieved before, the object is retrieved from the database

Returns:

the associated Attribute object

Throws:

org.apache.torque.TorqueException

getAttribute

public Attribute getAttribute(java.sql.Connection connection)
                       throws org.apache.torque.TorqueException

Return the associated Attribute object If it was not retrieved before, the object is retrieved from the database using the passed connection

Parameters:

connection - the connection used to retrieve the associated object from the database, if it was not retrieved before

Returns:

the associated Attribute object

Throws:

org.apache.torque.TorqueException

setAttributeKey

public void setAttributeKey(org.apache.torque.om.ObjectKey key)
                     throws org.apache.torque.TorqueException

Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())

Throws:

org.apache.torque.TorqueException

setAttributeOptionRelatedByFromOptionId

public void setAttributeOptionRelatedByFromOptionId(AttributeOption v)
                                             throws org.apache.torque.TorqueException

Declares an association between this object and a AttributeOption object

Parameters:

v - AttributeOption

Throws:

org.apache.torque.TorqueException

getAttributeOptionRelatedByFromOptionId

public AttributeOption getAttributeOptionRelatedByFromOptionId()
                                                        throws org.apache.torque.TorqueException

Returns the associated AttributeOption object. If it was not retrieved before, the object is retrieved from the database

Returns:

the associated AttributeOption object

Throws:

org.apache.torque.TorqueException

getAttributeOptionRelatedByFromOptionId

public AttributeOption getAttributeOptionRelatedByFromOptionId(java.sql.Connection connection)
                                                        throws org.apache.torque.TorqueException

Return the associated AttributeOption object If it was not retrieved before, the object is retrieved from the database using the passed connection

Parameters:

connection - the connection used to retrieve the associated object from the database, if it was not retrieved before

Returns:

the associated AttributeOption object

Throws:

org.apache.torque.TorqueException

setAttributeOptionRelatedByFromOptionIdKey

public void setAttributeOptionRelatedByFromOptionIdKey(org.apache.torque.om.ObjectKey key)
                                                throws org.apache.torque.TorqueException

Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())

Throws:

org.apache.torque.TorqueException

setAttributeOptionRelatedByToOptionId

public void setAttributeOptionRelatedByToOptionId(AttributeOption v)
                                           throws org.apache.torque.TorqueException

Declares an association between this object and a AttributeOption object

Parameters:

v - AttributeOption

Throws:

org.apache.torque.TorqueException

getAttributeOptionRelatedByToOptionId

public AttributeOption getAttributeOptionRelatedByToOptionId()
                                                      throws org.apache.torque.TorqueException

Returns the associated AttributeOption object. If it was not retrieved before, the object is retrieved from the database

Returns:

the associated AttributeOption object

Throws:

org.apache.torque.TorqueException

getAttributeOptionRelatedByToOptionId

public AttributeOption getAttributeOptionRelatedByToOptionId(java.sql.Connection connection)
                                                      throws org.apache.torque.TorqueException

Return the associated AttributeOption object If it was not retrieved before, the object is retrieved from the database using the passed connection

Parameters:

connection - the connection used to retrieve the associated object from the database, if it was not retrieved before

Returns:

the associated AttributeOption object

Throws:

org.apache.torque.TorqueException

setAttributeOptionRelatedByToOptionIdKey

public void setAttributeOptionRelatedByToOptionIdKey(org.apache.torque.om.ObjectKey key)
                                              throws org.apache.torque.TorqueException

Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())

Throws:

org.apache.torque.TorqueException

initConditions

protected void initConditions()

Temporary storage of collConditions to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.

addCondition

public void addCondition(Condition l)
                  throws org.apache.torque.TorqueException

Method called to associate a Condition object to this object through the Condition foreign key attribute

Parameters:

l - Condition

Throws:

org.apache.torque.TorqueException

getConditions

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

If this collection has already been initialized, returns the collection. Otherwise returns the results of getConditions(new Criteria())

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getConditions

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

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Transition has previously been saved, it will retrieve related Conditions from storage. If this Transition is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

Throws:

org.apache.torque.TorqueException

getConditions

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

If this collection has already been initialized, returns the collection. Otherwise returns the results of getConditions(new Criteria(),Connection) This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input

Throws:

org.apache.torque.TorqueException

getConditions

public java.util.List getConditions(org.apache.torque.util.Criteria criteria,
                                    java.sql.Connection con)
                             throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Transition has previously been saved, it will retrieve related Conditions from storage. If this Transition is new, it will return an empty collection or the current collection, the criteria is ignored on a new object. This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input

Throws:

org.apache.torque.TorqueException

getConditionsJoinRModuleAttribute

protected java.util.List getConditionsJoinRModuleAttribute(org.apache.torque.util.Criteria criteria)
                                                    throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Transition is new, it will return an empty collection; or if this Transition has previously been saved, it will retrieve related Conditions from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in Transition.

Throws:

org.apache.torque.TorqueException

getConditionsJoinTransition

protected java.util.List getConditionsJoinTransition(org.apache.torque.util.Criteria criteria)
                                              throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Transition is new, it will return an empty collection; or if this Transition has previously been saved, it will retrieve related Conditions from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in Transition.

Throws:

org.apache.torque.TorqueException

getConditionsJoinAttribute

protected java.util.List getConditionsJoinAttribute(org.apache.torque.util.Criteria criteria)
                                             throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Transition is new, it will return an empty collection; or if this Transition has previously been saved, it will retrieve related Conditions from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in Transition.

Throws:

org.apache.torque.TorqueException

getConditionsJoinAttributeOption

protected java.util.List getConditionsJoinAttributeOption(org.apache.torque.util.Criteria criteria)
                                                   throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Transition is new, it will return an empty collection; or if this Transition has previously been saved, it will retrieve related Conditions from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in Transition.

Throws:

org.apache.torque.TorqueException

getConditionsJoinRModuleIssueType

protected java.util.List getConditionsJoinRModuleIssueType(org.apache.torque.util.Criteria criteria)
                                                    throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Transition is new, it will return an empty collection; or if this Transition has previously been saved, it will retrieve related Conditions from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in Transition.

Throws:

org.apache.torque.TorqueException

getFieldNames

public static java.util.List getFieldNames()

Generate a list of field names.

Returns:

a list of field names

getByName

public java.lang.Object getByName(java.lang.String name)

Retrieves a field from the object by name passed in as a String.

Parameters:

name - field name

Returns:

value

getByPeerName

public java.lang.Object getByPeerName(java.lang.String name)

Retrieves a field from the object by name passed in as a String. The String must be one of the static Strings defined in this Class' Peer.

Parameters:

name - peer name

Returns:

value

getByPosition

public java.lang.Object getByPosition(int pos)

Retrieves a field from the object by Position as specified in the xml schema. Zero-based.

Parameters:

pos - position in xml schema

Returns:

value

save

public void save()
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed.

Specified by:

save in interface org.apache.torque.om.Persistent

Throws:

org.apache.torque.TorqueException

save

public void save(java.lang.String dbName)
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. Note: this code is here because the method body is auto-generated conditionally and therefore needs to be in this file instead of in the super class, BaseObject.

Specified by:

save in interface org.apache.torque.om.Persistent

Parameters:

dbName -

Throws:

org.apache.torque.TorqueException

save

public void save(java.sql.Connection con)
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. This method is meant to be used as part of a transaction, otherwise use the save() method and the connection details will be handled internally

Specified by:

save in interface org.apache.torque.om.Persistent

Parameters:

con -

Throws:

org.apache.torque.TorqueException

isCacheOnSave

protected boolean isCacheOnSave()

Specify whether to cache the object after saving to the db. This method returns true

setPrimaryKey

public void setPrimaryKey(org.apache.torque.om.ObjectKey key)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using ObjectKey.

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Parameters:

key - transitionId ObjectKey

Throws:

org.apache.torque.TorqueException

setPrimaryKey

public void setPrimaryKey(java.lang.String key)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using a String.

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Parameters:

key -

Throws:

org.apache.torque.TorqueException

getPrimaryKey

public org.apache.torque.om.ObjectKey getPrimaryKey()

returns an id that differentiates this object from others of its class.

Specified by:

getPrimaryKey in interface org.apache.torque.om.Persistent

getQueryKey

public java.lang.String getQueryKey()

get an id that differentiates this object from others of its class.

Specified by:

getQueryKey in interface org.apache.fulcrum.intake.Retrievable

setQueryKey

public void setQueryKey(java.lang.String key)
                 throws org.apache.torque.TorqueException

set an id that differentiates this object from others of its class.

Specified by:

setQueryKey in interface org.apache.fulcrum.intake.Retrievable

Throws:

org.apache.torque.TorqueException

copy

public Transition copy()
                throws org.apache.torque.TorqueException

Makes a copy of this object. It creates a new object filling in the simple attributes. It then fills all the association collections and sets the related objects to isNew=true.

Throws:

org.apache.torque.TorqueException

copyInto

protected Transition copyInto(Transition copyObj)
                       throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getPeer

public TransitionPeer getPeer()

returns a peer instance associated with this om. Since Peer classes are not to have any instance attributes, this method returns the same instance for all member of this class. The method could therefore be static, but this would prevent one from overriding the behavior.

toString

public java.lang.String toString()