Interface BranchSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BranchSearch
extends OsidSearch

The search interface for governing branch searches.

Method Summary

Modifier and Type	Method	Description
BranchSearchRecord	getBranchSearchRecord(Type branchSearchRecordType)	Gets the branch search record corresponding to the given branch search record Type.
void	orderBranchResults(BranchSearchOrder branchSearchOrder)	Specify an ordering to the search results.
void	searchAmongBranches(IdList branchIds)	Execute this search among the given list of branches.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongBranches

void searchAmongBranches(IdList branchIds)

Execute this search among the given list of branches.

Parameters:

branchIds - list of branch Ids

Throws:

NullArgumentException - branchIds is null

Compliance:

mandatory - This method must be implemented.

orderBranchResults

void orderBranchResults(BranchSearchOrder branchSearchOrder)

Specify an ordering to the search results.

Parameters:

branchSearchOrder - branch search order

Throws:

NullArgumentException - order is null

UnsupportedException - order is not of this service

Compliance:

mandatory - This method must be implemented.

getBranchSearchRecord

BranchSearchRecord getBranchSearchRecord(Type branchSearchRecordType)
                                  throws OperationFailedException

Gets the branch search record corresponding to the given branch search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

branchSearchRecordType - a branch search record type

Returns:

the branch search record

Throws:

NullArgumentException - branchSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(branchSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.