Interface TextSmartPressSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TextSmartPressSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A TextQuery can be retrieved from this session and pressped to this Press to create a virtual collection of Texts . The texts may be sequenced using the TextSearchOrder from this session.

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

Method Summary

Modifier and Type	Method	Description
void	applyTextQuery(TextQuery textQuery)	Applies a text query to this press.
void	applyTextSequencing(TextSearchOrder textSearchOrder)	Applies a text search order to this press.
boolean	canManageSmartPresses()	Tests if this user can manage smart presses.
Press	getPress()	Gets the Press associated with this session.
Id	getPressId()	Gets the Press Id associated with this session.
TextQuery	getTextQuery()	Gets a text query.
TextQuery	getTextQueryFromInspector(TextQueryInspector textQueryInspector)	Gets a text query from an inspector.
TextSearchOrder	getTextSearchOrder()	Gets a text search order.
TextQueryInspector	inspectTextQuery()	Gets a text 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.

getTextQuery

TextQuery getTextQuery()

Gets a text query.

Returns:

the text query

Compliance:

mandatory - This method must be implemented.

getTextSearchOrder

TextSearchOrder getTextSearchOrder()

Gets a text search order.

Returns:

the text search order

Compliance:

mandatory - This method must be implemented.

applyTextQuery

void applyTextQuery(TextQuery textQuery)
             throws OperationFailedException,
PermissionDeniedException

Applies a text query to this press.

Parameters:

textQuery - the text query

Throws:

NullArgumentException - textQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - textQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectTextQuery

TextQueryInspector inspectTextQuery()
                             throws OperationFailedException,
PermissionDeniedException

Gets a text query inspector for this press.

Returns:

the text query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyTextSequencing

void applyTextSequencing(TextSearchOrder textSearchOrder)
                  throws OperationFailedException,
PermissionDeniedException

Applies a text search order to this press.

Parameters:

textSearchOrder - the text search order

Throws:

NullArgumentException - textSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - textSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getTextQueryFromInspector

TextQuery getTextQueryFromInspector(TextQueryInspector textQueryInspector)

Gets a text query from an inspector.

Parameters:

textQueryInspector - a text query inspector

Returns:

the text query

Throws:

NullArgumentException - textQueryInspector is null

UnsupportedException - textQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.