org.osid.room

Interface FloorLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated campus view: All floor methods in this session operate, retrieve and pertain to floors defined explicitly in the current campus. Using an isolated view is useful for managing floors with the FloorAdminSession.
• federated campus view: All floor lookup methods in this session operate, retrieve and pertain to all floors defined in this campus and any other campuses implicitly available in this campus through campus inheritence.
• effective floor view: All floor lookup methods return effective floors.
• any effective floor view: Floors of any effective date are returned.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCampusId

Id getCampusId()

Gets the Campus Id associated with this session.

Returns:

the Campus Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCampus

Campus getCampus()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the Campus associated with this session.

Returns:

the campus

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupFloors

boolean canLookupFloors()

Tests if this user can perform 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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeFloorView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryFloorView

void usePlenaryFloorView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

useFederatedCampusView

void useFederatedCampusView()

Federates the view for methods in this session. A federated view will include floors in campuses which are children of this campus in the campus hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCampusView

void useIsolatedCampusView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.

Compliance:

mandatory - This method is must be implemented.

useEffectiveFloorView

void useEffectiveFloorView()

Only floors whose effective dates are current are returned by methods in this session

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveFloorView

void useAnyEffectiveFloorView()

Floors of any effective dates are returned by all methods in this session.

Compliance:

mandatory - This method is must be implemented.

getFloor

Floor getFloor(Id floorId)
               throws NotFoundException,
                      OperationFailedException,
                      PermissionDeniedException

Gets the 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.

Parameters:

floorId - Id of the Floor

Returns:

the floor

Throws:

NotFoundException - floorId not found

NullArgumentException - floorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getFloorsByIds

FloorList getFloorsByIds(IdList floorIds)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets a 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.

Parameters:

floorIds - the list of Ids to retrieve

Returns:

the returned Floor list

Throws:

NotFoundException - an Id was not found

NullArgumentException - floorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFloorsByGenusType

FloorList getFloorsByGenusType(Type floorGenusType)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets a 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.

Parameters:

floorGenusType - a floor genus type

Returns:

the returned Floor list

Throws:

NullArgumentException - floorGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFloorsByParentGenusType

FloorList getFloorsByParentGenusType(Type floorGenusType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets a 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.

Parameters:

floorGenusType - a floor genus type

Returns:

the returned Floor list

Throws:

NullArgumentException - floorGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFloorsByRecordType

FloorList getFloorsByRecordType(Type floorRecordType)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets a 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.

Parameters:

floorRecordType - a floor record type

Returns:

the returned Floor list

Throws:

NullArgumentException - floorRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFloorsOnDate

FloorList getFloorsOnDate(DateTime from,
                        DateTime to)
                          throws OperationFailedException,
                                 PermissionDeniedException

Gets a list of all floors 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.

Parameters:

from - start of date range

to - end of date range

Returns:

the returned FloorList

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFloorsForBuilding

FloorList getFloorsForBuilding(Id buildingId)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets a list of all floors corresponding to a building 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.

Parameters:

buildingId - the Id of the building

Returns:

the returned FloorList

Throws:

NullArgumentException - buildingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFloorsForBuildingOnDate

FloorList getFloorsForBuildingOnDate(Id buildingId,
                                   DateTime from,
                                   DateTime to)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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. 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.

Parameters:

buildingId - a building Id

from - from date

to - to date

Returns:

the returned FloorList

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - buildingId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFloorsByNumber

FloorList getFloorsByNumber(java.lang.String number)
                            throws OperationFailedException,
                                   PermissionDeniedException

Gets a list of all floors of the given number. 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.

Parameters:

number - a floor number

Returns:

the returned FloorList

Throws:

NullArgumentException - number is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFloors

FloorList getFloors()
                    throws OperationFailedException,
                           PermissionDeniedException

Gets all 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.

Returns:

a list of Floors

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.