public interface RenovationQuerySession extends OsidSession
This session provides methods for searching Renovation
objects. The search query is constructed using the RenovationQuery.
The renovation record Type
also specifies the
record for the renovation query.
Renovations may have a query record indicated by their respective
record types. The query record is accessed via the RenovationQuery.
The returns in this session may not be cast directly to these
interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchRenovations()
Tests if this user can perform
Renovation searches. |
Campus |
getCampus()
Gets the
Campus associated with this session. |
Id |
getCampusId()
Gets the
Campus Id associated with this
session. |
RenovationQuery |
getRenovationQuery()
Gets a renovation query.
|
RenovationList |
getRenovationsByQuery(RenovationQuery renovationQuery)
Gets a list of
Renovations matching the given
renovation query. |
void |
useFederatedCampusView()
Federates the view for methods in this session.
|
void |
useIsolatedCampusView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCampusId()
Campus
Id
associated with this
session. Campus Id
associated with this sessionmandatory
- This method must be implemented. Campus getCampus() throws OperationFailedException, PermissionDeniedException
Campus
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchRenovations()
Renovation
searches. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCampusView()
mandatory
- This method is must be implemented. void useIsolatedCampusView()
mandatory
- This method is must be implemented. RenovationQuery getRenovationQuery()
mandatory
- This method must be implemented. RenovationList getRenovationsByQuery(RenovationQuery renovationQuery) throws OperationFailedException, PermissionDeniedException
Renovations
matching the given
renovation query.renovationQuery
- the renovation query RenovationList
NullArgumentException
- renovationQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- renovationQuery
is not of this servicemandatory
- This method must be implemented.