org.osid.personnel

Interface PositionSmartRealmSession

All Superinterfaces:

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

public interface PositionSmartRealmSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A PositionQuery can be retrieved from this session and mapped to this Realm to create a virtual collection of Positions. The positions may be sequenced using the PositionSearchOrder from this session.

This Realm has a default query that matches any position and a default search order that specifies no sequencing. The queries may be examined using a PositionQueryInspector. The query may be modified by converting the inspector back to a PositionQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyPositionQuery(PositionQuery positionQuery) Applies a position query to this realm.
void	applyPositionSequencing(PositionSearchOrder positionSearchOrder) Applies a position search order to this realm.
boolean	canManageSmartRealms() Tests if this user can manage smart realms.
PositionQuery	getPositionQuery() Gets a position query.
PositionQuery	getPositionQueryFromInspector(PositionQueryInspector positionQueryInspector) Gets a position query from an inspector.
PositionSearchOrder	getPositionSearchOrder() Gets a position search order.
Realm	getRealm() Gets the Realm associated with this session.
Id	getRealmId() Gets the Realm Id associated with this session.
PositionQueryInspector	inspectPositionQuery() Gets a position query inspector for this realm.

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

getRealmId

Id getRealmId()

Gets the Realm Id associated with this session.

Returns:

the Realm Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRealm

Realm getRealm()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Realm associated with this session.

Returns:

the Realm associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartRealms

boolean canManageSmartRealms()

Tests if this user can manage smart realms. 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 realm management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getPositionQuery

PositionQuery getPositionQuery()

Gets a position query.

Returns:

the position query

Compliance:

mandatory - This method must be implemented.

getPositionSearchOrder

PositionSearchOrder getPositionSearchOrder()

Gets a position search order.

Returns:

the position search order

Compliance:

mandatory - This method must be implemented.

applyPositionQuery

void applyPositionQuery(PositionQuery positionQuery)
                        throws OperationFailedException,
                               PermissionDeniedException

Applies a position query to this realm.

Parameters:

positionQuery - the position query

Throws:

NullArgumentException - positionQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - positionQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectPositionQuery

PositionQueryInspector inspectPositionQuery()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets a position query inspector for this realm.

Returns:

the position query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyPositionSequencing

void applyPositionSequencing(PositionSearchOrder positionSearchOrder)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a position search order to this realm.

Parameters:

positionSearchOrder - the position search order

Throws:

NullArgumentException - positionSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - positionSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getPositionQueryFromInspector

PositionQuery getPositionQueryFromInspector(PositionQueryInspector positionQueryInspector)

Gets a position query from an inspector.

Parameters:

positionQueryInspector - a query inspector

Returns:

the position query

Throws:

NullArgumentException - positionQueryInspector is null

UnsupportedException - positionQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.