OSID Logo
OSID Specifications
lexicon package
Version 3.0.0
Interfaceosid.lexicon.PressSearchSession
Implementsosid.lexicon.PressQuerySession
Used Byosid.lexicon.LexiconManager
osid.lexicon.LexiconProxyManager
Description

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 .

MethodgetPressSearch
Description

Gets an press search.

Returnosid.lexicon.PressSearchthe press search
CompliancemandatoryThis method must be implemented.
MethodgetPressSearchOrder
Description

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

Returnosid.lexicon.PressSearchOrderthe press search order
CompliancemandatoryThis method must be implemented.
MethodgetPressesBySearch
Description

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

Parametersosid.lexicon.PressQuerypressQuerythe press query
osid.lexicon.PressSearchpressSearchthe press search
Returnosid.lexicon.PressSearchResultsthe press search results
ErrorsNULL_ARGUMENTpressQuery or pressSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDpressQuery or pressSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPressQueryFromInspector
Description

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

Parametersosid.lexicon.PressQueryInspectorpressQueryInspectoran press query inspector
Returnosid.lexicon.PressQuerythe press query
ErrorsNULL_ARGUMENTpressQueryInspector is null
UNSUPPORTEDpressQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.