| org.tigris.scarab.om.BaseQuery
All known Subclasses: org.tigris.scarab.om.Query,
| BaseQuery | | abstract public class BaseQuery 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 Query
|
| Method Summary | |
| public void | addRQueryUser(RQueryUser l)
| | public Query | copy()
Makes a copy of this object. | | protected Query | copyInto(Query copyObj)
| | public boolean | getApproved()
| | 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 Date | getCreatedDate()
| | public boolean | getDeleted()
| | public String | getDescription()
| | public static synchronized List | getFieldNames()
Generate a list of field names. | | public Frequency | getFrequency()
Returns the associated Frequency object. | | public Frequency | getFrequency(Connection connection)
| | public boolean | getHomePage()
| | public IssueType | getIssueType()
Returns the associated IssueType object. | | public IssueType | getIssueType(Connection connection)
| | public Integer | getIssueTypeId()
| | public Long | getListId()
| | public MITList | getMITList()
Returns the associated MITList object. | | public MITList | getMITList(Connection connection)
| | public Module | getModule()
Returns the associated Module object. | | public Module | getModule(Connection connection)
| | public Integer | getModuleId()
| | public String | getName()
| | public int | getOrder()
| | public QueryPeer | 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 Long | getQueryId()
| | public String | getQueryKey()
get an id that differentiates this object from others
of its class. | | 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 Query is new, it will return
an empty collection; or if this Query 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 Query is new, it will return
an empty collection; or if this Query 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 Query is new, it will return
an empty collection; or if this Query 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. | | public ScarabUser | getScarabUser()
Returns the associated ScarabUser object. | | public ScarabUser | getScarabUser(Connection connection)
| | public Scope | getScope()
Returns the associated Scope object. | | public Scope | getScope(Connection connection)
| | public Integer | getScopeId()
| | public Integer | getSubscriptionFrequencyId()
| | public Integer | getUserId()
| | public String | getValue()
| | 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 | setApproved(boolean v)
| | public void | setCreatedDate(Date v)
| | public void | setDeleted(boolean v)
| | public void | setDescription(String v)
| | public void | setFrequency(Frequency v)
| | public void | setFrequencyKey(ObjectKey key)
| | public void | setHomePage(boolean v)
| | public void | setIssueType(IssueType v)
| | public void | setIssueTypeId(Integer v)
| | public void | setIssueTypeKey(ObjectKey key)
| | public void | setListId(Long v)
| | public void | setMITList(MITList v)
| | public void | setMITListKey(ObjectKey key)
| | public void | setModule(Module v)
| | public void | setModuleId(Integer v)
| | public void | setModuleKey(ObjectKey key)
| | public void | setName(String v)
| | public void | setOrder(int v)
| | public void | setPrimaryKey(ObjectKey key)
Set the PrimaryKey using ObjectKey. | | public void | setPrimaryKey(String key)
Set the PrimaryKey using a String. | | public void | setQueryId(Long v)
| | public void | setQueryKey(String key)
set an id that differentiates this object from others
of its class. | | public void | setScarabUser(ScarabUser v)
| | public void | setScarabUserKey(ObjectKey key)
| | public void | setScope(Scope v)
| | public void | setScopeId(Integer v)
| | public void | setScopeKey(ObjectKey key)
| | public void | setSubscriptionFrequencyId(Integer v)
| | public void | setUserId(Integer v)
| | public void | setValue(String v)
| | public String | toString()
|
| collRQueryUsers | | protected List collRQueryUsers(Code) | | Collection to store aggregation of collRQueryUsers
|
| 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 Query 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.
|
| getApproved | | public boolean getApproved()(Code) | | Get the Approved
boolean |
| 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 |
| getCreatedDate | | public Date getCreatedDate()(Code) | | Get the CreatedDate
Date |
| getDeleted | | public boolean getDeleted()(Code) | | Get the Deleted
boolean |
| getDescription | | public String getDescription()(Code) | | Get the Description
String |
| getFieldNames | | public static synchronized List getFieldNames()(Code) | | Generate a list of field names.
a list of field names |
| getFrequency | | public Frequency getFrequency() throws TorqueException(Code) | | Returns the associated Frequency object.
If it was not retrieved before, the object is retrieved from
the database
the associated Frequency object
throws:
TorqueException - |
| getFrequency | | public Frequency getFrequency(Connection connection) throws TorqueException(Code) | | Return the associated Frequency 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 Frequency object
throws:
TorqueException - |
| getHomePage | | public boolean getHomePage()(Code) | | Get the HomePage
boolean |
| 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 |
| getListId | | public Long getListId()(Code) | | Get the ListId
Long |
| getMITList | | public MITList getMITList() throws TorqueException(Code) | | Returns the associated MITList object.
If it was not retrieved before, the object is retrieved from
the database
the associated MITList object
throws:
TorqueException - |
| getMITList | | public MITList getMITList(Connection connection) throws TorqueException(Code) | | Return the associated MITList 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 MITList object
throws:
TorqueException - |
| 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 QueryPeer 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.
|
| getQueryId | | public Long getQueryId()(Code) | | Get the QueryId
Long |
| getQueryKey | | public String getQueryKey()(Code) | | get an id that differentiates this object from others
of its class.
|
| 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 Query has previously
been saved, it will retrieve related RQueryUsers from storage.
If this Query 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 Query has previously
been saved, it will retrieve related RQueryUsers from storage.
If this Query 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 Query is new, it will return
an empty collection; or if this Query 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 Query.
|
| 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 Query is new, it will return
an empty collection; or if this Query 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 Query.
|
| 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 Query is new, it will return
an empty collection; or if this Query 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 Query.
|
| getScarabUser | | public ScarabUser getScarabUser() throws TorqueException(Code) | | Returns the associated ScarabUser object.
If it was not retrieved before, the object is retrieved from
the database
the associated ScarabUser object
throws:
TorqueException - |
| getScarabUser | | public ScarabUser getScarabUser(Connection connection) throws TorqueException(Code) | | Return the associated ScarabUser 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 ScarabUser object
throws:
TorqueException - |
| getScope | | public Scope getScope() throws TorqueException(Code) | | Returns the associated Scope object.
If it was not retrieved before, the object is retrieved from
the database
the associated Scope object
throws:
TorqueException - |
| getScope | | public Scope getScope(Connection connection) throws TorqueException(Code) | | Return the associated Scope 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 Scope object
throws:
TorqueException - |
| getScopeId | | public Integer getScopeId()(Code) | | Get the ScopeId
Integer |
| getSubscriptionFrequencyId | | public Integer getSubscriptionFrequencyId()(Code) | | Get the SubscriptionFrequencyId
Integer |
| 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 - |
| setApproved | | public void setApproved(boolean v)(Code) | | Set the value of Approved
Parameters:
v - new value |
| setCreatedDate | | public void setCreatedDate(Date v)(Code) | | Set the value of CreatedDate
Parameters:
v - new value |
| setDeleted | | public void setDeleted(boolean v)(Code) | | Set the value of Deleted
Parameters:
v - new value |
| setDescription | | public void setDescription(String v)(Code) | | Set the value of Description
Parameters:
v - new value |
| setFrequency | | public void setFrequency(Frequency v) throws TorqueException(Code) | | Declares an association between this object and a Frequency object
Parameters:
v - Frequency
throws:
TorqueException - |
| setFrequencyKey | | public void setFrequencyKey(ObjectKey key) throws TorqueException(Code) | | Provides convenient way to set a relationship based on a
ObjectKey, for example
bar.setFooKey(foo.getPrimaryKey())
|
| setHomePage | | public void setHomePage(boolean v)(Code) | | Set the value of HomePage
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())
|
| setListId | | public void setListId(Long v) throws TorqueException(Code) | | Set the value of ListId
Parameters:
v - new value |
| setMITList | | public void setMITList(MITList v) throws TorqueException(Code) | | Declares an association between this object and a MITList object
Parameters:
v - MITList
throws:
TorqueException - |
| setMITListKey | | public void setMITListKey(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())
|
| setName | | public void setName(String v)(Code) | | Set the value of Name
Parameters:
v - new value |
| 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 using ObjectKey.
Parameters:
key - queryId ObjectKey |
| setPrimaryKey | | public void setPrimaryKey(String key) throws TorqueException(Code) | | Set the PrimaryKey using a String.
Parameters:
key - |
| setQueryId | | public void setQueryId(Long v) throws TorqueException(Code) | | Set the value of QueryId
Parameters:
v - new value |
| setQueryKey | | public void setQueryKey(String key) throws TorqueException(Code) | | set an id that differentiates this object from others
of its class.
|
| setScarabUser | | public void setScarabUser(ScarabUser v) throws TorqueException(Code) | | Declares an association between this object and a ScarabUser object
Parameters:
v - ScarabUser
throws:
TorqueException - |
| setScarabUserKey | | public void setScarabUserKey(ObjectKey key) throws TorqueException(Code) | | Provides convenient way to set a relationship based on a
ObjectKey, for example
bar.setFooKey(foo.getPrimaryKey())
|
| setScope | | public void setScope(Scope v) throws TorqueException(Code) | | Declares an association between this object and a Scope object
Parameters:
v - Scope
throws:
TorqueException - |
| setScopeId | | public void setScopeId(Integer v) throws TorqueException(Code) | | Set the value of ScopeId
Parameters:
v - new value |
| setScopeKey | | public void setScopeKey(ObjectKey key) throws TorqueException(Code) | | Provides convenient way to set a relationship based on a
ObjectKey, for example
bar.setFooKey(foo.getPrimaryKey())
|
| setSubscriptionFrequencyId | | public void setSubscriptionFrequencyId(Integer v) throws TorqueException(Code) | | Set the value of SubscriptionFrequencyId
Parameters:
v - new value |
| setUserId | | public void setUserId(Integer v) throws TorqueException(Code) | | Set the value of UserId
Parameters:
v - new value |
| setValue | | public void setValue(String v)(Code) | | Set the value of Value
Parameters:
v - new value |
|
|