org.osid.repository.rules

Interface CompositionEnablerSmartRepositorySession

All Superinterfaces:

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

public interface CompositionEnablerSmartRepositorySession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic repositories. A CompositionEnablerQuery can be retrieved from this session and mapped to this Repository to create a virtual collection of composition enablers. The composition enablers may be sequenced using the CompositionEnablerSearchOrder from this session.

This Repository has a default query that matches any composition enabler and a default search order that specifies no sequencing. The queries may be examined using a CompositionEnablerQueryInspector. The query may be modified by converting the inspector back to a CompositionEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCompositionEnablerQuery(CompositionEnablerQuery compositionEnablerQuery) Applies a composition enabler query to this repository.
void	applyCompositionEnablerSequencing(CompositionEnablerSearchOrder compositionEnablerSearchOrder) Applies a composition enabler search order to this repository.
boolean	canManageSmartRepositories() Tests if this user can manage smart repositories.
CompositionEnablerQuery	getCompositionEnablerQuery() Gets a composition enabler query.
CompositionEnablerQuery	getCompositionEnablerQueryFromInspector(CompositionEnablerQueryInspector compositionEnablerQueryInspector) Gets a composition enabler query from an inspector.
CompositionEnablerSearchOrder	getCompositionEnablerSearchOrder() Gets a composition enabler search order.
Repository	getRepository() Gets the Repository associated with this session.
Id	getRepositoryId() Gets the Repository Id associated with this session.
CompositionEnablerQueryInspector	inspectCompositionEnablerQuery() Gets a composition enabler query inspector for this repository.

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

getRepositoryId

Id getRepositoryId()

Gets the Repository Id associated with this session.

Returns:

the Repository Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRepository

Repository getRepository()
                         throws OperationFailedException,
                                PermissionDeniedException

Gets the Repository associated with this session.

Returns:

the repository

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartRepositories

boolean canManageSmartRepositories()

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

Compliance:

mandatory - This method must be implemented.

getCompositionEnablerQuery

CompositionEnablerQuery getCompositionEnablerQuery()

Gets a composition enabler query.

Returns:

the composition enabler query

Compliance:

mandatory - This method must be implemented.

getCompositionEnablerSearchOrder

CompositionEnablerSearchOrder getCompositionEnablerSearchOrder()

Gets a composition enabler search order.

Returns:

the composition enabler search order

Compliance:

mandatory - This method must be implemented.

applyCompositionEnablerQuery

void applyCompositionEnablerQuery(CompositionEnablerQuery compositionEnablerQuery)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Applies a composition enabler query to this repository.

Parameters:

compositionEnablerQuery - the composition enabler query

Throws:

NullArgumentException - compositionEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - compositionEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectCompositionEnablerQuery

CompositionEnablerQueryInspector inspectCompositionEnablerQuery()
                                                                throws OperationFailedException,
                                                                       PermissionDeniedException

Gets a composition enabler query inspector for this repository.

Returns:

the composition enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyCompositionEnablerSequencing

void applyCompositionEnablerSequencing(CompositionEnablerSearchOrder compositionEnablerSearchOrder)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Applies a composition enabler search order to this repository.

Parameters:

compositionEnablerSearchOrder - the composition enabler search order

Throws:

NullArgumentException - compositionEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - compositionEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getCompositionEnablerQueryFromInspector

CompositionEnablerQuery getCompositionEnablerQueryFromInspector(CompositionEnablerQueryInspector compositionEnablerQueryInspector)

Gets a composition enabler query from an inspector.

Parameters:

compositionEnablerQueryInspector - a composition enabler query inspector

Returns:

the composition enabler query

Throws:

NullArgumentException - compositionEnablerQueryInspector is null

UnsupportedException - compositionEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.