org.osid.sequencing

Interface ChainSmartAntimatroidSession

All Superinterfaces:

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

public interface ChainSmartAntimatroidSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ChainQuery can be retrieved from this session and antimatroidped to this Antimatroid to create a virtual collection of Chains. The chains may be sequenced using the ChainSearchOrder from this session.

This Antimatroid has a default query that matches any chain and a default search order that specifies no sequencing. The queries may be examined using a ChainQueryInspector. The query may be modified by converting the inspector back to a ChainQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyChainQuery(ChainQuery chainQuery) Applies a chain query to this antimatroid.
void	applyChainSequencing(ChainSearchOrder chainSearchOrder) Applies a chain search order to this antimatroid.
boolean	canManageSmartAntimatroids() Tests if this user can manage smart antimatroids.
Antimatroid	getAntimatroid() Gets the Antimatroid associated with this session.
Id	getAntimatroidId() Gets the Antimatroid Id associated with this session.
ChainQuery	getChainQuery() Gets a chain query.
ChainQuery	getChainQueryFromInspector(ChainQueryInspector chainQueryInspector) Gets a chain query from an inspector.
ChainSearchOrder	getChainSearchOrder() Gets a chain search order.
ChainQueryInspector	inspectChainQuery() Gets a chain query inspector for this antimatroid.

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

getAntimatroidId

Id getAntimatroidId()

Gets the Antimatroid Id associated with this session.

Returns:

the Antimatroid Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAntimatroid

Antimatroid getAntimatroid()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the Antimatroid associated with this session.

Returns:

the antimatroid

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartAntimatroids

boolean canManageSmartAntimatroids()

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

Compliance:

mandatory - This method must be implemented.

getChainQuery

ChainQuery getChainQuery()

Gets a chain query.

Returns:

the chain query

Compliance:

mandatory - This method must be implemented.

getChainSearchOrder

ChainSearchOrder getChainSearchOrder()

Gets a chain search order.

Returns:

the chain search order

Compliance:

mandatory - This method must be implemented.

applyChainQuery

void applyChainQuery(ChainQuery chainQuery)
                     throws OperationFailedException,
                            PermissionDeniedException

Applies a chain query to this antimatroid.

Parameters:

chainQuery - the chain query

Throws:

NullArgumentException - chainQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - chainQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectChainQuery

ChainQueryInspector inspectChainQuery()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a chain query inspector for this antimatroid.

Returns:

the chain query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyChainSequencing

void applyChainSequencing(ChainSearchOrder chainSearchOrder)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies a chain search order to this antimatroid.

Parameters:

chainSearchOrder - the chain search order

Throws:

NullArgumentException - chainSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - chainSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getChainQueryFromInspector

ChainQuery getChainQueryFromInspector(ChainQueryInspector chainQueryInspector)

Gets a chain query from an inspector.

Parameters:

chainQueryInspector - a chain query inspector

Returns:

the chain query

Throws:

NullArgumentException - chainQueryInspector is null

UnsupportedException - chainQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.