public interface CampusSearchSession extends CampusQuerySession
This session provides methods for searching Campus
objects. The search query is constructed using the CampusQuery.
The campus record Type
also specifies the record
for the campus query.
getCampusesByQuery()
is the basic search method and
returns a list of Campus
elements. A more advanced search
may be performed with getCampusesBySearch().
It accepts a
CampusSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getCampusesBySearch()
returns a
CampusSearchResults
that can be used to access the resulting
CampusList
or be used to perform a search within the result
set through CampusSearch.
Campuses may have a query record indicated by their respective record
types. The query record is accessed via the CampusQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
CampusSearchResults |
getCampusesBySearch(CampusQuery campusQuery,
CampusSearch campusSearch)
Gets the search results matching the given search.
|
CampusQuery |
getCampusQueryFromInspector(CampusQueryInspector campusQueryInspector)
Gets an entry query from an inspector.
|
CampusSearch |
getCampusSearch()
Gets a campus search.
|
CampusSearchOrder |
getCampusSearchOrder()
Gets a campus search order.
|
canSearchCampuses, getCampusesByQuery, getCampusQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CampusSearch getCampusSearch()
mandatory
- This method must be implemented. CampusSearchOrder getCampusSearchOrder()
CampusSearchOrder
is
supplied to a CampusSearch
to specify the ordering of
results.mandatory
- This method must be implemented. CampusSearchResults getCampusesBySearch(CampusQuery campusQuery, CampusSearch campusSearch) throws OperationFailedException, PermissionDeniedException
campusQuery
- the campus querycampusSearch
- the campus searchNullArgumentException
- campusQuery
or
campusSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- campusQuery
or
campusSearch
is not of this servicemandatory
- This method must be implemented. CampusQuery getCampusQueryFromInspector(CampusQueryInspector campusQueryInspector)
CampusSearchResults.
campusQueryInspector
- a query inspectorNullArgumentException
- campusQueryInspector
is null
UnsupportedException
- campusQueryInspector
is not of this servicemandatory
- This method must be implemented.