org.osid.room

Interface FloorCampusSession

All Superinterfaces:

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

public interface FloorCampusSession
extends OsidSession

This session provides methods to retrieve Floor to Campus mappings. A Floor may appear in multiple Campuses. Each Campus may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupFloorCampusMappings() Tests if this user can perform lookups of floor/campus mappings.
CampusList	getCampusesByFloor(Id floorId) Gets the list of Campus objects mapped to a Floor.
IdList	getCampusIdsByFloor(Id floorId) Gets the list of Campus Ids mapped to a Floor.
IdList	getFloorIdsByCampus(Id campusId) Gets the list of Floor Ids associated with a Campus.
IdList	getFloorIdsByCampuses(IdList campusIds) Gets the list of Floor Ids corresponding to a list of Campus objects.
FloorList	getFloorsByCampus(Id campusId) Gets the list of Floors associated with a Campus.
FloorList	getFloorsByCampuses(IdList campusIds) Gets the list of Floors corresponding to a list of Campuses.
void	useComparativeCampusView() 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	usePlenaryCampusView() A complete view of the Floor and Campus 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

canLookupFloorCampusMappings

boolean canLookupFloorCampusMappings()

Tests if this user can perform lookups of floor/campus mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCampusView

void useComparativeCampusView()

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.

usePlenaryCampusView

void usePlenaryCampusView()

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

getFloorIdsByCampus

IdList getFloorIdsByCampus(Id campusId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets the list of Floor Ids associated with a Campus.

Parameters:

campusId - Id of a Campus

Returns:

list of related floor Ids

Throws:

NotFoundException - campusId is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFloorsByCampus

FloorList getFloorsByCampus(Id campusId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Gets the list of Floors associated with a Campus.

Parameters:

campusId - Id of a Campus

Returns:

list of related floors

Throws:

NotFoundException - campusId is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFloorIdsByCampuses

IdList getFloorIdsByCampuses(IdList campusIds)
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets the list of Floor Ids corresponding to a list of Campus objects.

Parameters:

campusIds - list of campus Ids

Returns:

list of floor Ids

Throws:

NullArgumentException - campusIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFloorsByCampuses

FloorList getFloorsByCampuses(IdList campusIds)
                              throws OperationFailedException,
                                     PermissionDeniedException

Gets the list of Floors corresponding to a list of Campuses.

Parameters:

campusIds - list of campus Ids

Returns:

list of floors

Throws:

NullArgumentException - campusIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCampusIdsByFloor

IdList getCampusIdsByFloor(Id floorId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets the list of Campus Ids mapped to a Floor.

Parameters:

floorId - Id of a Floor

Returns:

list of campus Ids

Throws:

NotFoundException - floorId is not found

NullArgumentException - floorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCampusesByFloor

CampusList getCampusesByFloor(Id floorId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets the list of Campus objects mapped to a Floor.

Parameters:

floorId - Id of a Floor

Returns:

list of campuses

Throws:

NotFoundException - floorId is not found

NullArgumentException - floorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.