| org.tigris.scarab.om.BaseRModuleAttribute
All known Subclasses: org.tigris.scarab.om.RModuleAttribute,
| BaseRModuleAttribute | | abstract public class BaseRModuleAttribute extends BaseObject implements org.apache.fulcrum.intake.Retrievable(Code) | | You should not use this class directly. It should not even be
extended all references should be to RModuleAttribute
|
| Method Summary | |
| public void | addCondition(Condition l)
| | public RModuleAttribute | copy()
Makes a copy of this object. | | protected RModuleAttribute | copyInto(RModuleAttribute copyObj)
| | public boolean | getActive()
| | public Attribute | getAttribute()
Returns the associated Attribute object. | | public Attribute | getAttribute(Connection connection)
| | public Integer | getAttributeId()
| | public Object | getByName(String name)
Retrieves a field from the object by name passed in as a String. | | public Object | getByPeerName(String name)
Retrieves a field from the object by name passed in
as a String. | | public Object | getByPosition(int pos)
Retrieves a field from the object by Position as specified
in the xml schema. | | public List | getConditions()
If this collection has already been initialized, returns
the collection. | | public List | getConditions(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection. | | public List | getConditions(Connection con)
If this collection has already been initialized, returns
the collection. | | public List | getConditions(Criteria criteria, Connection con)
If this collection has already been initialized with
an identical criteria, it returns the collection. | | protected List | getConditionsJoinAttribute(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this RModuleAttribute is new, it will return
an empty collection; or if this RModuleAttribute 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. | | protected List | getConditionsJoinAttributeOption(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this RModuleAttribute is new, it will return
an empty collection; or if this RModuleAttribute 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. | | protected List | getConditionsJoinRModuleAttribute(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this RModuleAttribute is new, it will return
an empty collection; or if this RModuleAttribute 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. | | protected List | getConditionsJoinRModuleIssueType(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this RModuleAttribute is new, it will return
an empty collection; or if this RModuleAttribute 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. | | protected List | getConditionsJoinTransition(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this RModuleAttribute is new, it will return
an empty collection; or if this RModuleAttribute 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. | | public boolean | getDefaultTextFlag()
| | public String | getDisplayValue()
| | public static synchronized List | getFieldNames()
Generate a list of field names. | | public IssueType | getIssueType()
Returns the associated IssueType object. | | public IssueType | getIssueType(Connection connection)
| | public Integer | getIssueTypeId()
| | public Module | getModule()
Returns the associated Module object. | | public Module | getModule(Connection connection)
| | public Integer | getModuleId()
| | public int | getOrder()
| | public RModuleAttributePeer | getPeer()
returns a peer instance associated with this om. | | public ObjectKey | getPrimaryKey()
returns an id that differentiates this object from others
of its class. | | public String | getQueryKey()
get an id that differentiates this object from others
of its class. | | public boolean | getQuickSearch()
| | public boolean | getRequired()
| | 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. | | public void | save()
Stores the object in the database. | | public void | save(String dbName)
Stores the object in the database. | | public void | save(Connection con)
Stores the object in the database. | | public void | setActive(boolean v)
| | public void | setAttribute(Attribute v)
| | public void | setAttributeId(Integer v)
| | public void | setAttributeKey(ObjectKey key)
| | public void | setDefaultTextFlag(boolean v)
| | public void | setDisplayValue(String v)
| | public void | setIssueType(IssueType v)
| | public void | setIssueTypeId(Integer v)
| | public void | setIssueTypeKey(ObjectKey key)
| | public void | setModule(Module v)
| | public void | setModuleId(Integer v)
| | public void | setModuleKey(ObjectKey key)
| | public void | setOrder(int v)
| | public void | setPrimaryKey(ObjectKey key)
| | public void | setPrimaryKey(Integer moduleId, Integer attributeId, Integer issueTypeId)
Set the PrimaryKey using SimpleKeys. | | public void | setPrimaryKey(String key)
Set the PrimaryKey using a String. | | public void | setQueryKey(String key)
set an id that differentiates this object from others
of its class. | | public void | setQuickSearch(boolean v)
| | public void | setRequired(boolean v)
| | public String | toString()
|
| collConditions | | protected List collConditions(Code) | | Collection to store aggregation of collConditions
|
| addCondition | | public void addCondition(Condition l) throws TorqueException(Code) | | Method called to associate a Condition object to this object
through the Condition foreign key attribute
Parameters:
l - Condition
throws:
TorqueException - |
| copy | | public RModuleAttribute copy() throws TorqueException(Code) | | 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.
|
| getActive | | public boolean getActive()(Code) | | Get the Active
boolean |
| getAttribute | | public Attribute getAttribute() throws TorqueException(Code) | | Returns the associated Attribute object.
If it was not retrieved before, the object is retrieved from
the database
the associated Attribute object
throws:
TorqueException - |
| getAttribute | | public Attribute getAttribute(Connection connection) throws TorqueException(Code) | | 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 objectfrom the database, if it was not retrieved before the associated Attribute object
throws:
TorqueException - |
| getAttributeId | | public Integer getAttributeId()(Code) | | Get the AttributeId
Integer |
| getByName | | public Object getByName(String name)(Code) | | Retrieves a field from the object by name passed in as a String.
Parameters:
name - field name value |
| getByPeerName | | public Object getByPeerName(String name)(Code) | | 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 value |
| getByPosition | | public Object getByPosition(int pos)(Code) | | Retrieves a field from the object by Position as specified
in the xml schema. Zero-based.
Parameters:
pos - position in xml schema value |
| getConditions | | public List getConditions() throws TorqueException(Code) | | If this collection has already been initialized, returns
the collection. Otherwise returns the results of
getConditions(new Criteria())
the collection of associated objects
throws:
TorqueException - |
| getConditions | | public List getConditions(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this RModuleAttribute has previously
been saved, it will retrieve related Conditions from storage.
If this RModuleAttribute is new, it will return
an empty collection or the current collection, the criteria
is ignored on a new object.
throws:
TorqueException - |
| getConditions | | public List getConditions(Connection con) throws TorqueException(Code) | | 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
|
| getConditions | | public List getConditions(Criteria criteria, Connection con) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this RModuleAttribute has previously
been saved, it will retrieve related Conditions from storage.
If this RModuleAttribute 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
|
| getConditionsJoinAttribute | | protected List getConditionsJoinAttribute(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this RModuleAttribute is new, it will return
an empty collection; or if this RModuleAttribute 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 RModuleAttribute.
|
| getConditionsJoinAttributeOption | | protected List getConditionsJoinAttributeOption(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this RModuleAttribute is new, it will return
an empty collection; or if this RModuleAttribute 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 RModuleAttribute.
|
| getConditionsJoinRModuleAttribute | | protected List getConditionsJoinRModuleAttribute(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this RModuleAttribute is new, it will return
an empty collection; or if this RModuleAttribute 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 RModuleAttribute.
|
| getConditionsJoinRModuleIssueType | | protected List getConditionsJoinRModuleIssueType(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this RModuleAttribute is new, it will return
an empty collection; or if this RModuleAttribute 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 RModuleAttribute.
|
| getConditionsJoinTransition | | protected List getConditionsJoinTransition(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this RModuleAttribute is new, it will return
an empty collection; or if this RModuleAttribute 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 RModuleAttribute.
|
| getDefaultTextFlag | | public boolean getDefaultTextFlag()(Code) | | Get the DefaultTextFlag
boolean |
| getDisplayValue | | public String getDisplayValue()(Code) | | Get the DisplayValue
String |
| getFieldNames | | public static synchronized List getFieldNames()(Code) | | Generate a list of field names.
a list of field names |
| getIssueType | | public IssueType getIssueType() throws TorqueException(Code) | | Returns the associated IssueType object.
If it was not retrieved before, the object is retrieved from
the database
the associated IssueType object
throws:
TorqueException - |
| getIssueType | | public IssueType getIssueType(Connection connection) throws TorqueException(Code) | | Return the associated IssueType 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 objectfrom the database, if it was not retrieved before the associated IssueType object
throws:
TorqueException - |
| getIssueTypeId | | public Integer getIssueTypeId()(Code) | | Get the IssueTypeId
Integer |
| getModule | | public Module getModule() throws TorqueException(Code) | | Returns the associated Module object.
If it was not retrieved before, the object is retrieved from
the database
the associated Module object
throws:
TorqueException - |
| getModule | | public Module getModule(Connection connection) throws TorqueException(Code) | | Return the associated Module 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 objectfrom the database, if it was not retrieved before the associated Module object
throws:
TorqueException - |
| getModuleId | | public Integer getModuleId()(Code) | | Get the ModuleId
Integer |
| getOrder | | public int getOrder()(Code) | | Get the Order
int |
| getPeer | | public RModuleAttributePeer getPeer()(Code) | | 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.
|
| getPrimaryKey | | public ObjectKey getPrimaryKey()(Code) | | returns an id that differentiates this object from others
of its class.
|
| getQueryKey | | public String getQueryKey()(Code) | | get an id that differentiates this object from others
of its class.
|
| getQuickSearch | | public boolean getQuickSearch()(Code) | | Get the QuickSearch
boolean |
| getRequired | | public boolean getRequired()(Code) | | Get the Required
boolean |
| initConditions | | protected void initConditions()(Code) | | 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.
|
| isCacheOnSave | | protected boolean isCacheOnSave()(Code) | | Specify whether to cache the object after saving to the db.
This method returns true
|
| save | | public void save() throws TorqueException(Code) | | Stores the object in the database. If the object is new,
it inserts it; otherwise an update is performed.
throws:
TorqueException - |
| save | | public void save(String dbName) throws TorqueException(Code) | | 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.
Parameters:
dbName -
throws:
TorqueException - |
| save | | public void save(Connection con) throws TorqueException(Code) | | 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
Parameters:
con -
throws:
TorqueException - |
| setActive | | public void setActive(boolean v)(Code) | | Set the value of Active
Parameters:
v - new value |
| setAttribute | | public void setAttribute(Attribute v) throws TorqueException(Code) | | Declares an association between this object and a Attribute object
Parameters:
v - Attribute
throws:
TorqueException - |
| setAttributeId | | public void setAttributeId(Integer v) throws TorqueException(Code) | | Set the value of AttributeId
Parameters:
v - new value |
| setAttributeKey | | public void setAttributeKey(ObjectKey key) throws TorqueException(Code) | | Provides convenient way to set a relationship based on a
ObjectKey, for example
bar.setFooKey(foo.getPrimaryKey())
|
| setDefaultTextFlag | | public void setDefaultTextFlag(boolean v)(Code) | | Set the value of DefaultTextFlag
Parameters:
v - new value |
| setDisplayValue | | public void setDisplayValue(String v)(Code) | | Set the value of DisplayValue
Parameters:
v - new value |
| setIssueType | | public void setIssueType(IssueType v) throws TorqueException(Code) | | Declares an association between this object and a IssueType object
Parameters:
v - IssueType
throws:
TorqueException - |
| setIssueTypeId | | public void setIssueTypeId(Integer v) throws TorqueException(Code) | | Set the value of IssueTypeId
Parameters:
v - new value |
| setIssueTypeKey | | public void setIssueTypeKey(ObjectKey key) throws TorqueException(Code) | | Provides convenient way to set a relationship based on a
ObjectKey, for example
bar.setFooKey(foo.getPrimaryKey())
|
| setModule | | public void setModule(Module v) throws TorqueException(Code) | | Declares an association between this object and a Module object
Parameters:
v - Module
throws:
TorqueException - |
| setModuleId | | public void setModuleId(Integer v) throws TorqueException(Code) | | Set the value of ModuleId
Parameters:
v - new value |
| setModuleKey | | public void setModuleKey(ObjectKey key) throws TorqueException(Code) | | Provides convenient way to set a relationship based on a
ObjectKey, for example
bar.setFooKey(foo.getPrimaryKey())
|
| setOrder | | public void setOrder(int v)(Code) | | Set the value of Order
Parameters:
v - new value |
| setPrimaryKey | | public void setPrimaryKey(ObjectKey key) throws TorqueException(Code) | | Set the PrimaryKey with an ObjectKey
Parameters:
key - |
| setPrimaryKey | | public void setPrimaryKey(Integer moduleId, Integer attributeId, Integer issueTypeId) throws TorqueException(Code) | | Set the PrimaryKey using SimpleKeys.
Parameters:
moduleId - Integer
Parameters:
attributeId - Integer
Parameters:
issueTypeId - Integer |
| setPrimaryKey | | public void setPrimaryKey(String key) throws TorqueException(Code) | | Set the PrimaryKey using a String.
|
| setQueryKey | | public void setQueryKey(String key) throws TorqueException(Code) | | set an id that differentiates this object from others
of its class.
|
| setQuickSearch | | public void setQuickSearch(boolean v)(Code) | | Set the value of QuickSearch
Parameters:
v - new value |
| setRequired | | public void setRequired(boolean v)(Code) | | Set the value of Required
Parameters:
v - new value |
|
|