org.osid.room

Interface BuildingSmartCampusSession

All Superinterfaces:

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

public interface BuildingSmartCampusSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A BuildingQuery can be retrieved from this session and mapped to this Campus to create a virtual collection of Buildings. The buildings may be sequenced using the BuildingSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyBuildingQuery(BuildingQuery buildingQuery) Applies a building query to this campus.
void	applyBuildingSequencing(BuildingSearchOrder buildingSearchOrder) Applies a building search order to this campus.
boolean	canManageSmartCampuses() Tests if this user can manage smart campuses.
BuildingQuery	getBuildingQuery() Gets a building query.
BuildingQuery	getBuildingQueryFromInspector(BuildingQueryInspector buildingQueryInspector) Gets a building query from an inspector.
BuildingSearchOrder	getBuildingSearchOrder() Gets a building search order.
Campus	getCampus() Gets the Campus associated with this session.
Id	getCampusId() Gets the Campus Id associated with this session.
BuildingQueryInspector	inspectBuildingQuery() Gets a building 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.

getBuildingQuery

BuildingQuery getBuildingQuery()

Gets a building query.

Returns:

the building query

Compliance:

mandatory - This method must be implemented.

getBuildingSearchOrder

BuildingSearchOrder getBuildingSearchOrder()

Gets a building search order.

Returns:

the building search order

Compliance:

mandatory - This method must be implemented.

applyBuildingQuery

void applyBuildingQuery(BuildingQuery buildingQuery)
                        throws OperationFailedException,
                               PermissionDeniedException

Applies a building query to this campus.

Parameters:

buildingQuery - the building query

Throws:

NullArgumentException - buildingQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - buildingQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectBuildingQuery

BuildingQueryInspector inspectBuildingQuery()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets a building query inspector for this campus.

Returns:

the building query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyBuildingSequencing

void applyBuildingSequencing(BuildingSearchOrder buildingSearchOrder)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a building search order to this campus.

Parameters:

buildingSearchOrder - the building search order

Throws:

NullArgumentException - buildingSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - buildingSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getBuildingQueryFromInspector

BuildingQuery getBuildingQueryFromInspector(BuildingQueryInspector buildingQueryInspector)

Gets a building query from an inspector.

Parameters:

buildingQueryInspector - a query inspector

Returns:

the building query

Throws:

NullArgumentException - buildingQueryInspector is null

UnsupportedException - buildingQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.