org.osid.offering.rules

Interface CanonicalUnitProcessorSmartCatalogueSession

All Superinterfaces:

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

public interface CanonicalUnitProcessorSmartCatalogueSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCanonicalUnitProcessorQuery(CanonicalUnitProcessorQuery canonicalUnitProcessorQuery) Applies a canonical unit processor query to this catalogue.
void	applyCanonicalUnitProcessorSequencing(CanonicalUnitProcessorSearchOrder canonicalUnitProcessorSearchOrder) Applies a canonical unit processor search order to this catalogue.
boolean	canManageSmartCatalogues() Tests if this user can manage smart catalogues.
CanonicalUnitProcessorQuery	getCanonicalUnitProcessorQuery() Gets a canonical unit processor query.
CanonicalUnitProcessorQuery	getCanonicalUnitProcessorQueryFromInspector(CanonicalUnitProcessorQueryInspector canonicalUnitProcessorQueryInspector) Gets a canonical unit processor query from an inspector.
CanonicalUnitProcessorSearchOrder	getCanonicalUnitProcessorSearchOrder() Gets a canonical unit processor search order.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
CanonicalUnitProcessorQueryInspector	inspectCanonicalUnitProcessorQuery() Gets a canonical unit processor 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.

getCanonicalUnitProcessorQuery

CanonicalUnitProcessorQuery getCanonicalUnitProcessorQuery()

Gets a canonical unit processor query.

Returns:

the canonical unit processor query

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorSearchOrder

CanonicalUnitProcessorSearchOrder getCanonicalUnitProcessorSearchOrder()

Gets a canonical unit processor search order.

Returns:

the canonical unit processor search order

Compliance:

mandatory - This method must be implemented.

applyCanonicalUnitProcessorQuery

void applyCanonicalUnitProcessorQuery(CanonicalUnitProcessorQuery canonicalUnitProcessorQuery)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Applies a canonical unit processor query to this catalogue.

Parameters:

canonicalUnitProcessorQuery - the canonical unit processor query

Throws:

NullArgumentException - canonicalUnitProcessorQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - canonicalUnitProcessorQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectCanonicalUnitProcessorQuery

CanonicalUnitProcessorQueryInspector inspectCanonicalUnitProcessorQuery()
                                                                        throws OperationFailedException,
                                                                               PermissionDeniedException

Gets a canonical unit processor query inspector for this catalogue.

Returns:

the canonical unit processor query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyCanonicalUnitProcessorSequencing

void applyCanonicalUnitProcessorSequencing(CanonicalUnitProcessorSearchOrder canonicalUnitProcessorSearchOrder)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Applies a canonical unit processor search order to this catalogue.

Parameters:

canonicalUnitProcessorSearchOrder - the canonical unit processor search order

Throws:

NullArgumentException - canonicalUnitProcessorSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - canonicalUnitProcessorSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorQueryFromInspector

CanonicalUnitProcessorQuery getCanonicalUnitProcessorQueryFromInspector(CanonicalUnitProcessorQueryInspector canonicalUnitProcessorQueryInspector)

Gets a canonical unit processor query from an inspector.

Parameters:

canonicalUnitProcessorQueryInspector - a canonical unit processor query inspector

Returns:

the canonical unit processor query

Throws:

NullArgumentException - canonicalUnitProcessorQueryInspector is null

UnsupportedException - canonicalUnitProcessorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.