org.osid.room.squatting

Interface DeedSmartCampusSession

All Superinterfaces:

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

public interface DeedSmartCampusSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A DeedQuery can be retrieved from this session and mapped to this Campus to create a virtual collection of Deeds. The deeds may be sequenced using the DeedSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyDeedQuery(DeedQuery deedQuery) Applies a deed query to this campus.
void	applyDeedSequencing(DeedSearchOrder deedSearchOrder) Applies a deed 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.
DeedQuery	getDeedQuery() Gets a deed query.
DeedQuery	getDeedQueryFromInspector(DeedQueryInspector deedQueryInspector) Gets a deed query from an inspector.
DeedSearchOrder	getDeedSearchOrder() Gets a deed search order.
DeedQueryInspector	inspectDeedQuery() Gets a deed 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.

getDeedQuery

DeedQuery getDeedQuery()

Gets a deed query.

Returns:

the deed query

Compliance:

mandatory - This method must be implemented.

getDeedSearchOrder

DeedSearchOrder getDeedSearchOrder()

Gets a deed search order.

Returns:

the deed search order

Compliance:

mandatory - This method must be implemented.

applyDeedQuery

void applyDeedQuery(DeedQuery deedQuery)
                    throws OperationFailedException,
                           PermissionDeniedException

Applies a deed query to this campus.

Parameters:

deedQuery - the deed query

Throws:

NullArgumentException - deedQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - deedQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectDeedQuery

DeedQueryInspector inspectDeedQuery()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a deed query inspector for this campus.

Returns:

the deed query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyDeedSequencing

void applyDeedSequencing(DeedSearchOrder deedSearchOrder)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a deed search order to this campus.

Parameters:

deedSearchOrder - the deed search order

Throws:

NullArgumentException - deedSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - deedSearchOrder did not originate from getDeedSearchOrder()

Compliance:

mandatory - This method must be implemented.

getDeedQueryFromInspector

DeedQuery getDeedQueryFromInspector(DeedQueryInspector deedQueryInspector)

Gets a deed query from an inspector.

Parameters:

deedQueryInspector - a query inspector

Returns:

the deed query

Throws:

NullArgumentException - deedQueryInspector is null

UnsupportedException - deedQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.