| org.tigris.scarab.om.BaseFrequency
All known Subclasses: org.tigris.scarab.om.Frequency,
| BaseFrequency | | abstract public class BaseFrequency 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 Frequency
|
| Method Summary | |
| public void | addQuery(Query l)
| | public void | addRQueryUser(RQueryUser l)
| | public Frequency | copy()
Makes a copy of this object. | | protected Frequency | copyInto(Frequency copyObj)
| | 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 static synchronized List | getFieldNames()
Generate a list of field names. | | public Integer | getFrequencyId()
| | public String | getName()
| | public FrequencyPeer | 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 List | getQuerys()
If this collection has already been initialized, returns
the collection. | | public List | getQuerys(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection. | | public List | getQuerys(Connection con)
If this collection has already been initialized, returns
the collection. | | public List | getQuerys(Criteria criteria, Connection con)
If this collection has already been initialized with
an identical criteria, it returns the collection. | | protected List | getQuerysJoinFrequency(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related Querys from storage.
This method is protected by default in order to keep the public
api reasonable. | | protected List | getQuerysJoinIssueType(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related Querys from storage.
This method is protected by default in order to keep the public
api reasonable. | | protected List | getQuerysJoinMITList(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related Querys from storage.
This method is protected by default in order to keep the public
api reasonable. | | protected List | getQuerysJoinScarabModule(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related Querys from storage.
This method is protected by default in order to keep the public
api reasonable. | | protected List | getQuerysJoinScarabUserImpl(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related Querys from storage.
This method is protected by default in order to keep the public
api reasonable. | | protected List | getQuerysJoinScope(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related Querys from storage.
This method is protected by default in order to keep the public
api reasonable. | | public List | getRQueryUsers()
If this collection has already been initialized, returns
the collection. | | public List | getRQueryUsers(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection. | | public List | getRQueryUsers(Connection con)
If this collection has already been initialized, returns
the collection. | | public List | getRQueryUsers(Criteria criteria, Connection con)
If this collection has already been initialized with
an identical criteria, it returns the collection. | | protected List | getRQueryUsersJoinFrequency(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related RQueryUsers from storage.
This method is protected by default in order to keep the public
api reasonable. | | protected List | getRQueryUsersJoinQuery(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related RQueryUsers from storage.
This method is protected by default in order to keep the public
api reasonable. | | protected List | getRQueryUsersJoinScarabUserImpl(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related RQueryUsers from storage.
This method is protected by default in order to keep the public
api reasonable. | | protected void | initQuerys()
Temporary storage of collQuerys to save a possible db hit in
the event objects are add to the collection, but the
complete collection is never requested. | | protected void | initRQueryUsers()
Temporary storage of collRQueryUsers 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 | setFrequencyId(Integer v)
| | public void | setName(String v)
| | public void | setPrimaryKey(ObjectKey key)
Set the PrimaryKey using ObjectKey. | | 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 String | toString()
|
| collQuerys | | protected List collQuerys(Code) | | Collection to store aggregation of collQuerys
|
| collRQueryUsers | | protected List collRQueryUsers(Code) | | Collection to store aggregation of collRQueryUsers
|
| addQuery | | public void addQuery(Query l) throws TorqueException(Code) | | Method called to associate a Query object to this object
through the Query foreign key attribute
Parameters:
l - Query
throws:
TorqueException - |
| addRQueryUser | | public void addRQueryUser(RQueryUser l) throws TorqueException(Code) | | Method called to associate a RQueryUser object to this object
through the RQueryUser foreign key attribute
Parameters:
l - RQueryUser
throws:
TorqueException - |
| copy | | public Frequency 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.
|
| 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 |
| getFieldNames | | public static synchronized List getFieldNames()(Code) | | Generate a list of field names.
a list of field names |
| getFrequencyId | | public Integer getFrequencyId()(Code) | | Get the FrequencyId
Integer |
| getPeer | | public FrequencyPeer 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.
|
| getQuerys | | public List getQuerys() throws TorqueException(Code) | | If this collection has already been initialized, returns
the collection. Otherwise returns the results of
getQuerys(new Criteria())
the collection of associated objects
throws:
TorqueException - |
| getQuerys | | public List getQuerys(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency has previously
been saved, it will retrieve related Querys from storage.
If this Frequency is new, it will return
an empty collection or the current collection, the criteria
is ignored on a new object.
throws:
TorqueException - |
| getQuerys | | public List getQuerys(Connection con) throws TorqueException(Code) | | If this collection has already been initialized, returns
the collection. Otherwise returns the results of
getQuerys(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
|
| getQuerys | | public List getQuerys(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 Frequency has previously
been saved, it will retrieve related Querys from storage.
If this Frequency 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
|
| getQuerysJoinFrequency | | protected List getQuerysJoinFrequency(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related Querys 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 Frequency.
|
| getQuerysJoinIssueType | | protected List getQuerysJoinIssueType(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related Querys 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 Frequency.
|
| getQuerysJoinMITList | | protected List getQuerysJoinMITList(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related Querys 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 Frequency.
|
| getQuerysJoinScarabModule | | protected List getQuerysJoinScarabModule(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related Querys 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 Frequency.
|
| getQuerysJoinScarabUserImpl | | protected List getQuerysJoinScarabUserImpl(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related Querys 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 Frequency.
|
| getQuerysJoinScope | | protected List getQuerysJoinScope(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related Querys 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 Frequency.
|
| getRQueryUsers | | public List getRQueryUsers() throws TorqueException(Code) | | If this collection has already been initialized, returns
the collection. Otherwise returns the results of
getRQueryUsers(new Criteria())
the collection of associated objects
throws:
TorqueException - |
| getRQueryUsers | | public List getRQueryUsers(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency has previously
been saved, it will retrieve related RQueryUsers from storage.
If this Frequency is new, it will return
an empty collection or the current collection, the criteria
is ignored on a new object.
throws:
TorqueException - |
| getRQueryUsers | | public List getRQueryUsers(Connection con) throws TorqueException(Code) | | If this collection has already been initialized, returns
the collection. Otherwise returns the results of
getRQueryUsers(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
|
| getRQueryUsers | | public List getRQueryUsers(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 Frequency has previously
been saved, it will retrieve related RQueryUsers from storage.
If this Frequency 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
|
| getRQueryUsersJoinFrequency | | protected List getRQueryUsersJoinFrequency(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related RQueryUsers 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 Frequency.
|
| getRQueryUsersJoinQuery | | protected List getRQueryUsersJoinQuery(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related RQueryUsers 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 Frequency.
|
| getRQueryUsersJoinScarabUserImpl | | protected List getRQueryUsersJoinScarabUserImpl(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Frequency is new, it will return
an empty collection; or if this Frequency has previously
been saved, it will retrieve related RQueryUsers 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 Frequency.
|
| initQuerys | | protected void initQuerys()(Code) | | Temporary storage of collQuerys to save a possible db hit in
the event objects are add to the collection, but the
complete collection is never requested.
|
| initRQueryUsers | | protected void initRQueryUsers()(Code) | | Temporary storage of collRQueryUsers 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 - |
| setFrequencyId | | public void setFrequencyId(Integer v) throws TorqueException(Code) | | Set the value of FrequencyId
Parameters:
v - new value |
| setName | | public void setName(String v)(Code) | | Set the value of Name
Parameters:
v - new value |
| setPrimaryKey | | public void setPrimaryKey(ObjectKey key) throws TorqueException(Code) | | Set the PrimaryKey using ObjectKey.
Parameters:
key - frequencyId ObjectKey |
| setPrimaryKey | | public void setPrimaryKey(String key) throws TorqueException(Code) | | Set the PrimaryKey using a String.
Parameters:
key - |
| setQueryKey | | public void setQueryKey(String key) throws TorqueException(Code) | | set an id that differentiates this object from others
of its class.
|
|
|