public interface FloorQuerySession extends OsidSession
This session provides methods for searching Floor
objects. The search query is constructed using the FloorQuery.
The floor record Type
also specifies the record for
the floor query.
Floors may have a query record indicated by their respective record
types. The query record is accessed via the FloorQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchFloors()
Tests if this user can perform
Floor searches. |
Campus |
getCampus()
Gets the
Campus associated with this session. |
Id |
getCampusId()
Gets the
Campus Id associated with this
session. |
FloorQuery |
getFloorQuery()
Gets a floor query.
|
FloorList |
getFloorsByQuery(FloorQuery floorQuery)
Gets a list of
Floors matching the given floor 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 canSearchFloors()
Floor
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. FloorQuery getFloorQuery()
mandatory
- This method must be implemented. FloorList getFloorsByQuery(FloorQuery floorQuery) throws OperationFailedException, PermissionDeniedException
Floors
matching the given floor query.floorQuery
- the floor query FloorList
NullArgumentException
- floorQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- floorQuery
is not
of this servicemandatory
- This method must be implemented.