Interface PressSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PressQuerySession

public interface PressSearchSession
extends PressQuerySession

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

getPressesByQuery() is the basic search method and returns a list of Presses . A more advanced search may be performed with getPressesBySearch() .It accepts a PressSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPressesBySearch() returns a PressSearchResults that can be used to access the resulting PressList or be used to perform a search within the result set through PressSearch .

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
PressSearchResults	getPressesBySearch(PressQuery pressQuery, PressSearch pressSearch)	Gets the search results matching the given search query using the given search.
PressQuery	getPressQueryFromInspector(PressQueryInspector pressQueryInspector)	Gets an press query from an inspector.
PressSearch	getPressSearch()	Gets an press search.
PressSearchOrder	getPressSearchOrder()	Gets an press search order.

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.

Methods inherited from interface PressQuerySession

canSearchPresses, getPressesByQuery, getPressQuery

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.

Method Details

getPressSearch

PressSearch getPressSearch()

Gets an press search.

Returns:

the press search

Compliance:

mandatory - This method must be implemented.

getPressSearchOrder

PressSearchOrder getPressSearchOrder()

Gets an press search order. The PressSearchOrder is supplied to a PressSearch to specify the ordering of results.

Returns:

the press search order

Compliance:

mandatory - This method must be implemented.

getPressesBySearch

PressSearchResults getPressesBySearch(PressQuery pressQuery,
 PressSearch pressSearch)
                               throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

pressQuery - the press query

pressSearch - the press search

Returns:

the press search results

Throws:

NullArgumentException - pressQuery or pressSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - pressQuery or pressSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPressQueryFromInspector

PressQuery getPressQueryFromInspector(PressQueryInspector pressQueryInspector)

Gets an press query from an inspector. The inspector is available from a PressSearchResults .

Parameters:

pressQueryInspector - an press query inspector

Returns:

the press query

Throws:

NullArgumentException - pressQueryInspector is null

UnsupportedException - pressQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.