| org.tigris.scarab.om.BaseScope
All known Subclasses: org.tigris.scarab.om.Scope,
| BaseScope | | abstract public class BaseScope 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 Scope
|
| Method Summary | |
| public void | addIssueTemplateInfo(IssueTemplateInfo l)
| | public void | addQuery(Query l)
| | public void | addReport(Report l)
| | public Scope | copy()
Makes a copy of this object. | | protected Scope | copyInto(Scope 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 List | getIssueTemplateInfos()
If this collection has already been initialized, returns
the collection. | | public List | getIssueTemplateInfos(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection. | | public List | getIssueTemplateInfos(Connection con)
If this collection has already been initialized, returns
the collection. | | public List | getIssueTemplateInfos(Criteria criteria, Connection con)
If this collection has already been initialized with
an identical criteria, it returns the collection. | | protected List | getIssueTemplateInfosJoinIssue(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope is new, it will return
an empty collection; or if this Scope has previously
been saved, it will retrieve related IssueTemplateInfos from storage.
This method is protected by default in order to keep the public
api reasonable. | | protected List | getIssueTemplateInfosJoinScope(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope is new, it will return
an empty collection; or if this Scope has previously
been saved, it will retrieve related IssueTemplateInfos from storage.
This method is protected by default in order to keep the public
api reasonable. | | public String | getName()
| | public ScopePeer | 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 Scope is new, it will return
an empty collection; or if this Scope 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 Scope is new, it will return
an empty collection; or if this Scope 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 Scope is new, it will return
an empty collection; or if this Scope 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 Scope is new, it will return
an empty collection; or if this Scope 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 Scope is new, it will return
an empty collection; or if this Scope 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 Scope is new, it will return
an empty collection; or if this Scope 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 | getReports()
If this collection has already been initialized, returns
the collection. | | public List | getReports(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection. | | public List | getReports(Connection con)
If this collection has already been initialized, returns
the collection. | | public List | getReports(Criteria criteria, Connection con)
If this collection has already been initialized with
an identical criteria, it returns the collection. | | protected List | getReportsJoinIssueType(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope is new, it will return
an empty collection; or if this Scope has previously
been saved, it will retrieve related Reports from storage.
This method is protected by default in order to keep the public
api reasonable. | | protected List | getReportsJoinScarabModule(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope is new, it will return
an empty collection; or if this Scope has previously
been saved, it will retrieve related Reports from storage.
This method is protected by default in order to keep the public
api reasonable. | | protected List | getReportsJoinScarabUserImpl(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope is new, it will return
an empty collection; or if this Scope has previously
been saved, it will retrieve related Reports from storage.
This method is protected by default in order to keep the public
api reasonable. | | protected List | getReportsJoinScope(Criteria criteria)
If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope is new, it will return
an empty collection; or if this Scope has previously
been saved, it will retrieve related Reports from storage.
This method is protected by default in order to keep the public
api reasonable. | | public Integer | getScopeId()
| | protected void | initIssueTemplateInfos()
Temporary storage of collIssueTemplateInfos to save a possible db hit in
the event objects are add to the collection, but the
complete collection is never requested. | | 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 | initReports()
Temporary storage of collReports 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 | 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 void | setScopeId(Integer v)
| | public String | toString()
|
| collIssueTemplateInfos | | protected List collIssueTemplateInfos(Code) | | Collection to store aggregation of collIssueTemplateInfos
|
| collQuerys | | protected List collQuerys(Code) | | Collection to store aggregation of collQuerys
|
| collReports | | protected List collReports(Code) | | Collection to store aggregation of collReports
|
| addIssueTemplateInfo | | public void addIssueTemplateInfo(IssueTemplateInfo l) throws TorqueException(Code) | | Method called to associate a IssueTemplateInfo object to this object
through the IssueTemplateInfo foreign key attribute
Parameters:
l - IssueTemplateInfo
throws:
TorqueException - |
| 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 - |
| addReport | | public void addReport(Report l) throws TorqueException(Code) | | Method called to associate a Report object to this object
through the Report foreign key attribute
Parameters:
l - Report
throws:
TorqueException - |
| copy | | public Scope 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 |
| getIssueTemplateInfos | | public List getIssueTemplateInfos() throws TorqueException(Code) | | If this collection has already been initialized, returns
the collection. Otherwise returns the results of
getIssueTemplateInfos(new Criteria())
the collection of associated objects
throws:
TorqueException - |
| getIssueTemplateInfos | | public List getIssueTemplateInfos(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope has previously
been saved, it will retrieve related IssueTemplateInfos from storage.
If this Scope is new, it will return
an empty collection or the current collection, the criteria
is ignored on a new object.
throws:
TorqueException - |
| getIssueTemplateInfos | | public List getIssueTemplateInfos(Connection con) throws TorqueException(Code) | | If this collection has already been initialized, returns
the collection. Otherwise returns the results of
getIssueTemplateInfos(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
|
| getIssueTemplateInfos | | public List getIssueTemplateInfos(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 Scope has previously
been saved, it will retrieve related IssueTemplateInfos from storage.
If this Scope 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
|
| getIssueTemplateInfosJoinIssue | | protected List getIssueTemplateInfosJoinIssue(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope is new, it will return
an empty collection; or if this Scope has previously
been saved, it will retrieve related IssueTemplateInfos 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 Scope.
|
| getIssueTemplateInfosJoinScope | | protected List getIssueTemplateInfosJoinScope(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope is new, it will return
an empty collection; or if this Scope has previously
been saved, it will retrieve related IssueTemplateInfos 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 Scope.
|
| getPeer | | public ScopePeer 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 Scope has previously
been saved, it will retrieve related Querys from storage.
If this Scope 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 Scope has previously
been saved, it will retrieve related Querys from storage.
If this Scope 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 Scope is new, it will return
an empty collection; or if this Scope 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 Scope.
|
| 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 Scope is new, it will return
an empty collection; or if this Scope 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 Scope.
|
| 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 Scope is new, it will return
an empty collection; or if this Scope 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 Scope.
|
| 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 Scope is new, it will return
an empty collection; or if this Scope 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 Scope.
|
| 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 Scope is new, it will return
an empty collection; or if this Scope 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 Scope.
|
| 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 Scope is new, it will return
an empty collection; or if this Scope 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 Scope.
|
| getReports | | public List getReports() throws TorqueException(Code) | | If this collection has already been initialized, returns
the collection. Otherwise returns the results of
getReports(new Criteria())
the collection of associated objects
throws:
TorqueException - |
| getReports | | public List getReports(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope has previously
been saved, it will retrieve related Reports from storage.
If this Scope is new, it will return
an empty collection or the current collection, the criteria
is ignored on a new object.
throws:
TorqueException - |
| getReports | | public List getReports(Connection con) throws TorqueException(Code) | | If this collection has already been initialized, returns
the collection. Otherwise returns the results of
getReports(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
|
| getReports | | public List getReports(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 Scope has previously
been saved, it will retrieve related Reports from storage.
If this Scope 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
|
| getReportsJoinIssueType | | protected List getReportsJoinIssueType(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope is new, it will return
an empty collection; or if this Scope has previously
been saved, it will retrieve related Reports 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 Scope.
|
| getReportsJoinScarabModule | | protected List getReportsJoinScarabModule(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope is new, it will return
an empty collection; or if this Scope has previously
been saved, it will retrieve related Reports 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 Scope.
|
| getReportsJoinScarabUserImpl | | protected List getReportsJoinScarabUserImpl(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope is new, it will return
an empty collection; or if this Scope has previously
been saved, it will retrieve related Reports 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 Scope.
|
| getReportsJoinScope | | protected List getReportsJoinScope(Criteria criteria) throws TorqueException(Code) | | If this collection has already been initialized with
an identical criteria, it returns the collection.
Otherwise if this Scope is new, it will return
an empty collection; or if this Scope has previously
been saved, it will retrieve related Reports 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 Scope.
|
| getScopeId | | public Integer getScopeId()(Code) | | Get the ScopeId
Integer |
| initIssueTemplateInfos | | protected void initIssueTemplateInfos()(Code) | | Temporary storage of collIssueTemplateInfos to save a possible db hit in
the event objects are add to the collection, but the
complete collection is never requested.
|
| 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.
|
| initReports | | protected void initReports()(Code) | | Temporary storage of collReports 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 - |
| 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 - scopeId 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.
|
| setScopeId | | public void setScopeId(Integer v) throws TorqueException(Code) | | Set the value of ScopeId
Parameters:
v - new value |
|
|