org.osid.room.construction

Interface ProjectSmartCampusSession

All Superinterfaces:

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

public interface ProjectSmartCampusSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProjectQuery can be retrieved from this session and mapped to this Campus to create a virtual collection of Projects. The projects may be sequenced using the ProjectSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProjectQuery(ProjectQuery projectQuery) Applies a project query to this campus.
void	applyProjectSequencing(ProjectSearchOrder projectSearchOrder) Applies a project 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.
ProjectQuery	getProjectQuery() Gets a project query.
ProjectQuery	getProjectQueryFromInspector(ProjectQueryInspector projectQueryInspector) Gets a project query from an inspector.
ProjectSearchOrder	getProjectSearchOrder() Gets a project search order.
ProjectQueryInspector	inspectProjectQuery() Gets a project 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.

getProjectQuery

ProjectQuery getProjectQuery()

Gets a project query.

Returns:

the project query

Compliance:

mandatory - This method must be implemented.

getProjectSearchOrder

ProjectSearchOrder getProjectSearchOrder()

Gets a project search order.

Returns:

the project search order

Compliance:

mandatory - This method must be implemented.

applyProjectQuery

void applyProjectQuery(ProjectQuery projectQuery)
                       throws OperationFailedException,
                              PermissionDeniedException

Applies a project query to this campus.

Parameters:

projectQuery - the project query

Throws:

NullArgumentException - projectQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - projectQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectProjectQuery

ProjectQueryInspector inspectProjectQuery()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a project query inspector for this campus.

Returns:

the project query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyProjectSequencing

void applyProjectSequencing(ProjectSearchOrder projectSearchOrder)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a project search order to this campus.

Parameters:

projectSearchOrder - the project search order

Throws:

NullArgumentException - projectSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - projectSearchOrder did not originate from getProjectSearchOrder()

Compliance:

mandatory - This method must be implemented.

getProjectQueryFromInspector

ProjectQuery getProjectQueryFromInspector(ProjectQueryInspector projectQueryInspector)

Gets a project query from an inspector.

Parameters:

projectQueryInspector - a query inspector

Returns:

the project query

Throws:

NullArgumentException - projectQueryInspector is null

UnsupportedException - projectQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.