org.osid.offering.rules

Interface CanonicalUnitEnablerSmartCatalogueSession

All Superinterfaces:

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

public interface CanonicalUnitEnablerSmartCatalogueSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogues. A CanonicalUnitEnablerQuery can be retrieved from this session and mapped to this Catalogue to create a virtual collection of canonical unit enablers. The canonical unit enablers may be sequenced using the CanonicalUnitEnablerSearchOrder from this session.

This Catalogue has a default query that matches any canonical unit enabler and a default search order that specifies no sequencing. The queries may be examined using a CanonicalUnitEnablerQueryInspector. The query may be modified by converting the inspector back to a CanonicalUnitEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCanonicalUnitEnablerQuery(CanonicalUnitEnablerQuery canonicalUnitEnablerQuery) Applies a canonical unit enabler query to this catalogue.
void	applyCanonicalUnitEnablerSequencing(CanonicalUnitEnablerSearchOrder canonicalUnitEnablerSearchOrder) Applies a canonical unit enabler search order to this catalogue.
boolean	canManageSmartCatalogues() Tests if this user can manage smart catalogues.
CanonicalUnitEnablerQuery	getCanonicalUnitEnablerQuery() Gets a canonical unit enabler query.
CanonicalUnitEnablerQuery	getCanonicalUnitEnablerQueryFromInspector(CanonicalUnitEnablerQueryInspector canonicalUnitEnablerQueryInspector) Gets a canonical unit enabler query from an inspector.
CanonicalUnitEnablerSearchOrder	getCanonicalUnitEnablerSearchOrder() Gets a canonical unit enabler search order.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
CanonicalUnitEnablerQueryInspector	inspectCanonicalUnitEnablerQuery() Gets a canonical unit enabler query inspector for this catalogue.

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

getCatalogueId

Id getCatalogueId()

Gets the Catalogue Id associated with this session.

Returns:

the Catalogue Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCatalogue

Catalogue getCatalogue()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Catalogue associated with this session.

Returns:

the catalogue

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartCatalogues

boolean canManageSmartCatalogues()

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

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablerQuery

CanonicalUnitEnablerQuery getCanonicalUnitEnablerQuery()

Gets a canonical unit enabler query.

Returns:

the canonical unit enabler query

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablerSearchOrder

CanonicalUnitEnablerSearchOrder getCanonicalUnitEnablerSearchOrder()

Gets a canonical unit enabler search order.

Returns:

the canonical unit enabler search order

Compliance:

mandatory - This method must be implemented.

applyCanonicalUnitEnablerQuery

void applyCanonicalUnitEnablerQuery(CanonicalUnitEnablerQuery canonicalUnitEnablerQuery)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Applies a canonical unit enabler query to this catalogue.

Parameters:

canonicalUnitEnablerQuery - the canonical unit enabler query

Throws:

NullArgumentException - canonicalUnitEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - canonicalUnitEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectCanonicalUnitEnablerQuery

CanonicalUnitEnablerQueryInspector inspectCanonicalUnitEnablerQuery()
                                                                    throws OperationFailedException,
                                                                           PermissionDeniedException

Gets a canonical unit enabler query inspector for this catalogue.

Returns:

the canonical unit enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyCanonicalUnitEnablerSequencing

void applyCanonicalUnitEnablerSequencing(CanonicalUnitEnablerSearchOrder canonicalUnitEnablerSearchOrder)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Applies a canonical unit enabler search order to this catalogue.

Parameters:

canonicalUnitEnablerSearchOrder - the canonical unit enabler search order

Throws:

NullArgumentException - canonicalUnitEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - canonicalUnitEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablerQueryFromInspector

CanonicalUnitEnablerQuery getCanonicalUnitEnablerQueryFromInspector(CanonicalUnitEnablerQueryInspector canonicalUnitEnablerQueryInspector)

Gets a canonical unit enabler query from an inspector.

Parameters:

canonicalUnitEnablerQueryInspector - a canonical unit enabler query inspector

Returns:

the canonical unit enabler query

Throws:

NullArgumentException - canonicalUnitEnablerQueryInspector is null

UnsupportedException - canonicalUnitEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.