org.osid.room

Interface FloorSmartCampusSession

All Superinterfaces:

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

public interface FloorSmartCampusSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A FloorQuery can be retrieved from this session and mapped to this Campus to create a virtual collection of Floors. The floors may be sequenced using the FloorSearchOrder from this session.

This Campus has a default query that matches any floor and a default search order that specifies no sequencing. The queries may be examined using a FloorQueryInspector. The query may be modified by converting the inspector back to a FloorQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyFloorQuery(FloorQuery floorQuery) Applies a floor query to this campus.
void	applyFloorSequencing(FloorSearchOrder floorSearchOrder) Applies a floor search order to this campus.
boolean	canManageSmartCampuses() Tests if this user can manage smart campuses.
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.
FloorQuery	getFloorQueryFromInspector(FloorQueryInspector floorQueryInspector) Gets a floor query from an inspector.
FloorSearchOrder	getFloorSearchOrder() Gets a floor search order.
FloorQueryInspector	inspectFloorQuery() Gets a floor query inspector for this campus.

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 associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartCampuses

boolean canManageSmartCampuses()

Tests if this user can manage smart campuses. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart campus management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getFloorQuery

FloorQuery getFloorQuery()

Gets a floor query.

Returns:

the floor query

Compliance:

mandatory - This method must be implemented.

getFloorSearchOrder

FloorSearchOrder getFloorSearchOrder()

Gets a floor search order.

Returns:

the floor search order

Compliance:

mandatory - This method must be implemented.

applyFloorQuery

void applyFloorQuery(FloorQuery floorQuery)
                     throws OperationFailedException,
                            PermissionDeniedException

Applies a floor query to this campus.

Parameters:

floorQuery - the floor query

Throws:

NullArgumentException - floorQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - floorQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectFloorQuery

FloorQueryInspector inspectFloorQuery()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a floor query inspector for this campus.

Returns:

the floor query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyFloorSequencing

void applyFloorSequencing(FloorSearchOrder floorSearchOrder)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies a floor search order to this campus.

Parameters:

floorSearchOrder - the floor search order

Throws:

NullArgumentException - floorSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - floorSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getFloorQueryFromInspector

FloorQuery getFloorQueryFromInspector(FloorQueryInspector floorQueryInspector)

Gets a floor query from an inspector.

Parameters:

floorQueryInspector - a query inspector

Returns:

the floor query

Throws:

NullArgumentException - floorQueryInspector is null

UnsupportedException - floorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.