public interface ProjectSearchSession extends ProjectQuerySession
This session provides methods for searching Project
objects. The search query is constructed using the ProjectQuery.
The project record Type
also specifies the record
for the project query.
getProjectsByQuery()
is the basic search method and
returns a list of Project
elements. A more advanced search
may be performed with getProjectsBySearch().
It accepts a
ProjectSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getProjectsBySearch()
returns a
ProjectSearchResults
that can be used to access the resulting
ProjectList
or be used to perform a search within the
result set through ProjectSearch.
Projects may have a query record indicated by their respective record
types. The query record is accessed via the ProjectQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
ProjectQuery |
getProjectQueryFromInspector(ProjectQueryInspector projectQueryInspector)
Gets a project query from an inspector.
|
ProjectSearchResults |
getProjectsBySearch(ProjectQuery projectQuery,
ProjectSearch projectSearch)
Gets the search results matching the given search.
|
ProjectSearch |
getProjectSearch()
Gets a project search.
|
ProjectSearchOrder |
getProjectSearchOrder()
Gets a project search order.
|
canSearchProjects, getCampus, getCampusId, getProjectQuery, getProjectsByQuery, useFederatedCampusView, useIsolatedCampusView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProjectSearch getProjectSearch()
mandatory
- This method must be implemented. ProjectSearchOrder getProjectSearchOrder()
ProjectSearchOrder
is
supplied to a ProjectSearch
to specify the ordering of
results.mandatory
- This method must be implemented. ProjectSearchResults getProjectsBySearch(ProjectQuery projectQuery, ProjectSearch projectSearch) throws OperationFailedException, PermissionDeniedException
projectQuery
- the project queryprojectSearch
- the project searchNullArgumentException
- projectQuery
or
projectSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- projectQuery
or
projectSearch
is not of this servicemandatory
- This method must be implemented. ProjectQuery getProjectQueryFromInspector(ProjectQueryInspector projectQueryInspector)
ProjectSearchResults.
projectQueryInspector
- a query inspectorNullArgumentException
- projectQueryInspector
is null
UnsupportedException
- projectQueryInspector
is not of this servicemandatory
- This method must be implemented.