org.osid.offering

Interface ResultSmartCatalogueSession

All Superinterfaces:

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

public interface ResultSmartCatalogueSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An ResultQuery can be retrieved from this session and mapped to this Catalogue to create a virtual collection of Results. The results may be sequenced using the ResultSearchOrder from this session.

This Catalogue has a default query that matches any result and a default search order that specifies no sequencing. The queries may be examined using an ResultQueryInspector. The query may be modified by converting the inspector back to an ResultQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyResultQuery(ResultQuery resultQuery) Applies an result query to this catalogue.
void	applyResultSequencing(ResultSearchOrder resultSearchOrder) Applies an result search order to this catalogue.
boolean	canManageSmartCatalogues() Tests if this user can manage smart catalogues.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
ResultQuery	getResultQuery() Gets an result query.
ResultQuery	getResultQueryFromInspector(ResultQueryInspector resultQueryInspector) Gets an result query from an inspector.
ResultSearchOrder	getResultSearchOrder() Gets an result search order.
ResultQueryInspector	inspectResultQuery() Gets an result 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 associated with this session

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.

getResultQuery

ResultQuery getResultQuery()

Gets an result query.

Returns:

the result query

Compliance:

mandatory - This method must be implemented.

getResultSearchOrder

ResultSearchOrder getResultSearchOrder()

Gets an result search order.

Returns:

the result search order

Compliance:

mandatory - This method must be implemented.

applyResultQuery

void applyResultQuery(ResultQuery resultQuery)
                      throws OperationFailedException,
                             PermissionDeniedException

Applies an result query to this catalogue.

Parameters:

resultQuery - the result query

Throws:

NullArgumentException - resultQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - resultQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectResultQuery

ResultQueryInspector inspectResultQuery()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets an result query inspector for this catalogue.

Returns:

the result query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyResultSequencing

void applyResultSequencing(ResultSearchOrder resultSearchOrder)
                           throws OperationFailedException,
                                  PermissionDeniedException

Applies an result search order to this catalogue.

Parameters:

resultSearchOrder - the result search order

Throws:

NullArgumentException - resultSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - resultSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getResultQueryFromInspector

ResultQuery getResultQueryFromInspector(ResultQueryInspector resultQueryInspector)

Gets an result query from an inspector.

Parameters:

resultQueryInspector - a query inspector

Returns:

the result query

Throws:

NullArgumentException - resultQueryInspector is null

UnsupportedException - resultQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.