Interface PressQuerySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

PressSearchSession

public interface PressQuerySession
extends OsidSession

This session provides methods for searching among Presses . The search query is constructed using the PressQuery .

Presses may have a query record indicated by their respective record types. The query record is accessed via the PressQuery .

Method Summary

Modifier and Type	Method	Description
boolean	canSearchPresses()	Tests if this user can perform Press searches.
PressList	getPressesByQuery(PressQuery pressQuery)	Gets a list of Presses matching the given press query.
PressQuery	getPressQuery()	Gets an press query.

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

canSearchPresses

boolean canSearchPresses()

Tests if this user can perform Press searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an press that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getPressQuery

PressQuery getPressQuery()

Gets an press query.

Returns:

the press query

Compliance:

mandatory - This method must be implemented.

getPressesByQuery

PressList getPressesByQuery(PressQuery pressQuery)
                     throws OperationFailedException,
PermissionDeniedException

Gets a list of Presses matching the given press query.

Parameters:

pressQuery - the press query

Returns:

the returned PressList

Throws:

NullArgumentException - pressQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - pressQuery is not of this service

Compliance:

mandatory - This method must be implemented.