public interface FloorLookupSession extends OsidSession
This session provides methods for retrieving Floor
objects. The Floor
represents a collection of rooms.
This session defines views that offer differing behaviors when retrieving multiple objects.
FloorAdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupFloors()
Tests if this user can perform
Floor lookups. |
Campus |
getCampus()
Gets the
Campus associated with this session. |
Id |
getCampusId()
Gets the
Campus Id associated with this
session. |
Floor |
getFloor(Id floorId)
Gets the
Floor specified by its Id. |
FloorList |
getFloors()
Gets all
Floors. |
FloorList |
getFloorsByGenusType(Type floorGenusType)
Gets a
FloorList corresponding to the given floor genus
Type which does not include floors of genus types
derived from the specified Type. |
FloorList |
getFloorsByIds(IdList floorIds)
Gets a
FloorList corresponding to the given
IdList. |
FloorList |
getFloorsByNumber(java.lang.String number)
Gets a list of all floors of the given number.
|
FloorList |
getFloorsByParentGenusType(Type floorGenusType)
Gets a
FloorList corresponding to the given floor genus
Type and include any additional floors with genus types
derived from the specified Type. |
FloorList |
getFloorsByRecordType(Type floorRecordType)
Gets a
FloorList containing the given floor record
Type. |
FloorList |
getFloorsForBuilding(Id buildingId)
Gets a list of all floors corresponding to a building
Id. |
FloorList |
getFloorsForBuildingOnDate(Id buildingId,
DateTime from,
DateTime to)
Gets a list of all floors corresponding to a building
Id
and effective during the entire given date range inclusive but
not confined to the date range. |
FloorList |
getFloorsOnDate(DateTime from,
DateTime to)
Gets a list of all floors effective during the entire given date range
inclusive but not confined to the date range.
|
void |
useAnyEffectiveFloorView()
Floors of any effective dates are returned by all methods in this
session.
|
void |
useComparativeFloorView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useEffectiveFloorView()
Only floors whose effective dates are current are returned by methods
in this session
|
void |
useFederatedCampusView()
Federates the view for methods in this session.
|
void |
useIsolatedCampusView()
Isolates the view for methods in this session.
|
void |
usePlenaryFloorView()
A complete view of the
Floor returns is desired. |
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 canLookupFloors()
Floor
lookups. 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 not offer lookup operations to unauthorized
users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeFloorView()
mandatory
- This method is must be implemented. void usePlenaryFloorView()
Floor
returns is desired.
Methods will return what is requested or result in an error. This view
is used when greater precision is desired at the expense of
interoperability.mandatory
- This method is must be implemented. void useFederatedCampusView()
mandatory
- This method is must be implemented. void useIsolatedCampusView()
mandatory
- This method is must be implemented. void useEffectiveFloorView()
mandatory
- This method is must be implemented. void useAnyEffectiveFloorView()
mandatory
- This method is must be implemented. Floor getFloor(Id floorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Floor
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Floor
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Floor
and retained for compatibility.
In effective mode, floors are returned that are currently effective.
In any effective mode, effective floors and those currently expired
are returned.floorId
- Id
of the Floor
NotFoundException
- floorId
not foundNullArgumentException
- floorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. FloorList getFloorsByIds(IdList floorIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
FloorList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
floors specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Floors
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In effective mode, floors are returned that are currently effective.
In any effective mode, effective floors and those currently expired
are returned.floorIds
- the list of Ids
to retrieve Floor
listNotFoundException
- an Id
was not foundNullArgumentException
- floorIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FloorList getFloorsByGenusType(Type floorGenusType) throws OperationFailedException, PermissionDeniedException
FloorList
corresponding to the given floor genus
Type
which does not include floors of genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
floors or an error results. Otherwise, the returned list may contain
only those floors that are accessible through this session.
In effective mode, floors are returned that are currently effective.
In any effective mode, effective floors and those currently expired
are returned.floorGenusType
- a floor genus type Floor
listNullArgumentException
- floorGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FloorList getFloorsByParentGenusType(Type floorGenusType) throws OperationFailedException, PermissionDeniedException
FloorList
corresponding to the given floor genus
Type
and include any additional floors with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
floors or an error results. Otherwise, the returned list may contain
only those floors that are accessible through this session.
In effective mode, floors are returned that are currently effective.
In any effective mode, effective floors and those currently expired
are returned.floorGenusType
- a floor genus type Floor
listNullArgumentException
- floorGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FloorList getFloorsByRecordType(Type floorRecordType) throws OperationFailedException, PermissionDeniedException
FloorList
containing the given floor record
Type.
In plenary mode, the returned list contains all known
floors or an error results. Otherwise, the returned list may contain
only those floors that are accessible through this session.
In effective mode, floors are returned that are currently effective.
In any effective mode, effective floors and those currently expired
are returned.floorRecordType
- a floor record type Floor
listNullArgumentException
- floorRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FloorList getFloorsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
from
- start of date rangeto
- end of date range FloorList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FloorList getFloorsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
Id.
In plenary mode, the returned list contains all known floors or an
error results. Otherwise, the returned list may contain only those
floors that are accessible through this session.
In effective mode, floors are returned that are currently effective.
In any effective mode, effective floors and those currently expired
are returned.buildingId
- the Id
of the building FloorList
NullArgumentException
- buildingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FloorList getFloorsForBuildingOnDate(Id buildingId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Id
and effective during the entire given date range inclusive but
not confined to the date range.
In plenary mode, the returned list contains all known floors or an
error results. Otherwise, the returned list may contain only those
floors that are accessible through this session.
In effective mode, floors are returned that are currently effective.
In any effective mode, effective floors and those currently expired
are returned.buildingId
- a building Id
from
- from dateto
- to date FloorList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- buildingId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FloorList getFloorsByNumber(java.lang.String number) throws OperationFailedException, PermissionDeniedException
number
- a floor number FloorList
NullArgumentException
- number
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FloorList getFloors() throws OperationFailedException, PermissionDeniedException
Floors.
In plenary mode, the returned list contains all known floors or an
error results. Otherwise, the returned list may contain only those
floors that are accessible through this session.
In effective mode, floors are returned that are currently effective.
In any effective mode, effective floors and those currently expired
are returned. Floors
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.