Interface BranchSearchSession

All Superinterfaces:

AutoCloseable, BranchQuerySession, Closeable, OsidSession, OsidSession

public interface BranchSearchSession
extends BranchQuerySession

This session provides methods for searching among Branches . The search query is constructed using the BranchQuery .

getBranchsByQuery() is the basic search method and returns a list of Branches . A more advanced search may be performed with getBranchesBySearch() .It accepts an BranchSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBranchesBySearch() returns an BranchSearchResults that can be used to access the resulting BranchList or be used to perform a search within the result set through BranchList .

This session defines views that offer differing behaviors for searching.

• federated journal view: searches include branches in journals of which this journal is a ancestor in the journal hierarchy
• isolated journal view: searches are restricted to branches in this journal

Branches may have a query record indicated by their respective recod types. The query record is accessed via the BranchQuery .

Method Summary

Modifier and Type	Method	Description
BranchSearchResults	getBranchesBySearch(BranchQuery branchQuery, BranchSearch branchSearch)	Gets the search results matching the given search query using the given search.
BranchQuery	getBranchQueryFromInspector(BranchQueryInspector branchQueryInspector)	Gets a branch query from an inspector.
BranchSearch	getBranchSearch()	Gets a branch search.
BranchSearchOrder	getBranchSearchOrder()	Gets a branch search order.

Methods inherited from interface BranchQuerySession

canSearchBranches, getBranchesByQuery, getBranchQuery, getJournal, getJournalId, useFederatedJournalView, useIsolatedJournalView

Modifier and Type	Method	Description
boolean	canSearchBranches()	Tests if this user can perform Branch searches.
BranchList	getBranchesByQuery(BranchQuery branchQuery)	Gets a list of Branches matching the given branch query.
BranchQuery	getBranchQuery()	Gets a branch query.
Journal	getJournal()	Gets the Journal associated with this session.
Id	getJournalId()	Gets the Journal Id associated with this session.
void	useFederatedJournalView()	Federates the view for methods in this session.
void	useIsolatedJournalView()	Isolates the view for methods in this session.

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

getBranchSearch

BranchSearch getBranchSearch()

Gets a branch search.

Returns:

the branch search

Compliance:

mandatory - This method must be implemented.

getBranchSearchOrder

BranchSearchOrder getBranchSearchOrder()

Gets a branch search order. The BranchSearchOrder is supplied to a BranchSearch to specify the ordering of results.

Returns:

the branch search order

Compliance:

mandatory - This method must be implemented.

getBranchesBySearch

BranchSearchResults getBranchesBySearch(BranchQuery branchQuery,
 BranchSearch branchSearch)
                                 throws OperationFailedException,
PermissionDeniedException

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

Parameters:

branchQuery - the branch query

branchSearch - the branch search

Returns:

the returned search results

Throws:

NullArgumentException - branchQuery or branchSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - branchQuery or branchSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBranchQueryFromInspector

BranchQuery getBranchQueryFromInspector(BranchQueryInspector branchQueryInspector)

Gets a branch query from an inspector. The inspector is available from a BranchSearchResults .

Parameters:

branchQueryInspector - a branch query inspector

Returns:

the branch query

Throws:

NullArgumentException - branchQueryInspector is null

UnsupportedException - branchQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.