Interface IdiomSmartPressSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IdiomSmartPressSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An IdiomQuery can be retrieved from this session and pressped to this Press to create a virtual collection of Idioms . The idioms may be sequenced using the IdiomSearchOrder from this session.

This Press has a default query that matches any idiom and a default search order that specifies no sequencing. The queries may be examined using an IdiomQueryInspector . The query may be modified by converting the inspector back to an IdiomQuery .

Method Summary

Modifier and Type	Method	Description
void	applyIdiomQuery(IdiomQuery idiomQuery)	Applies an idiom query to this press.
void	applyIdiomSequencing(IdiomSearchOrder idiomSearchOrder)	Applies an idiom search order to this press.
boolean	canManageSmartPresses()	Tests if this user can manage smart presses.
IdiomQuery	getIdiomQuery()	Gets an idiom query.
IdiomQuery	getIdiomQueryFromInspector(IdiomQueryInspector idiomQueryInspector)	Gets an idiom query from an inspector.
IdiomSearchOrder	getIdiomSearchOrder()	Gets an idiom search order.
Press	getPress()	Gets the Press associated with this session.
Id	getPressId()	Gets the Press Id associated with this session.
IdiomQueryInspector	inspectIdiomQuery()	Gets an idiom query inspector for this press.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getPressId

Id getPressId()

Gets the Press Id associated with this session.

Returns:

the Press Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPress

Press getPress()
        throws OperationFailedException,
PermissionDeniedException

Gets the Press associated with this session.

Returns:

the press

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartPresses

boolean canManageSmartPresses()

Tests if this user can manage smart presses. 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 press that may opt not to offer operations to unauthorized users.

Returns:

false if smart press management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getIdiomQuery

IdiomQuery getIdiomQuery()

Gets an idiom query.

Returns:

the idiom query

Compliance:

mandatory - This method must be implemented.

getIdiomSearchOrder

IdiomSearchOrder getIdiomSearchOrder()

Gets an idiom search order.

Returns:

the idiom search order

Compliance:

mandatory - This method must be implemented.

applyIdiomQuery

void applyIdiomQuery(IdiomQuery idiomQuery)
              throws OperationFailedException,
PermissionDeniedException

Applies an idiom query to this press.

Parameters:

idiomQuery - the idiom query

Throws:

NullArgumentException - idiomQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - idiomQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectIdiomQuery

IdiomQueryInspector inspectIdiomQuery()
                               throws OperationFailedException,
PermissionDeniedException

Gets an idiom query inspector for this press.

Returns:

the idiom query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyIdiomSequencing

void applyIdiomSequencing(IdiomSearchOrder idiomSearchOrder)
                   throws OperationFailedException,
PermissionDeniedException

Applies an idiom search order to this press.

Parameters:

idiomSearchOrder - the idiom search order

Throws:

NullArgumentException - idiomSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - idiomSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getIdiomQueryFromInspector

IdiomQuery getIdiomQueryFromInspector(IdiomQueryInspector idiomQueryInspector)

Gets an idiom query from an inspector.

Parameters:

idiomQueryInspector - an idiom query inspector

Returns:

the idiom query

Throws:

NullArgumentException - idiomQueryInspector is null

UnsupportedException - idiomQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.