Interface WorkSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, WorkQuerySession

public interface WorkSearchSession
extends WorkQuerySession

This session provides methods for searching among Works . The search query is constructed using the WorkQuery .

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

This session defines views that offer differing behaviors for searching.

• federated office view: searches include works in offices of which this office is an ancestor in the office hierarchy
• isolated office view: searches are restricted to works in this office

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

Method Summary

Modifier and Type	Method	Description
WorkQuery	getWorkQueryFromInspector(WorkQueryInspector workQueryInspector)	Gets a work query from an inspector.
WorkSearchResults	getWorksBySearch(WorkQuery workQuery, WorkSearch workSearch)	Gets the search results matching the given search query using the given search.
WorkSearch	getWorkSearch()	Gets a work search.
WorkSearchOrder	getWorkSearchOrder()	Gets a work 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 WorkQuerySession

canSearchWorks, getOffice, getOfficeId, getWorkQuery, getWorksByQuery, useFederatedOfficeView, useIsolatedOfficeView

Modifier and Type	Method	Description
boolean	canSearchWorks()	Tests if this user can perform Work lookups.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
WorkQuery	getWorkQuery()	Gets a work query.
WorkList	getWorksByQuery(WorkQuery workQuery)	Gets a list of Works matching the given work query.
void	useFederatedOfficeView()	Federates the view for methods in this session.
void	useIsolatedOfficeView()	Isolates the view for methods in this session.

Method Details

getWorkSearch

WorkSearch getWorkSearch()

Gets a work search.

Returns:

the work search

Compliance:

mandatory - This method must be implemented.

getWorkSearchOrder

WorkSearchOrder getWorkSearchOrder()

Gets a work search order. The WorkSearchOrder is supplied to a WorkSearch to specify the ordering of results.

Returns:

the work search order

Compliance:

mandatory - This method must be implemented.

getWorksBySearch

WorkSearchResults getWorksBySearch(WorkQuery workQuery,
 WorkSearch workSearch)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

workQuery - the work query

workSearch - the work search

Returns:

the work search results

Throws:

NullArgumentException - workQuery or workSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - workQuery or workSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getWorkQueryFromInspector

WorkQuery getWorkQueryFromInspector(WorkQueryInspector workQueryInspector)

Gets a work query from an inspector. The inspector is available from a WorkSearchResults .

Parameters:

workQueryInspector - a work query inspector

Returns:

the work query

Throws:

NullArgumentException - workQueryInspector is null

UnsupportedException - workQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.