public interface BranchSearch extends OsidSearch
The search interface for governing branch searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongBranches(IdList branchIds)
branchIds
- list of branch Ids
NullArgumentException
- branchIds
is
null
mandatory
- This method must be implemented. void orderBranchResults(BranchSearchOrder branchSearchOrder)
branchSearchOrder
- branch search orderNullArgumentException
- order
is
null
UnsupportedException
- order
is not of
this servicemandatory
- This method must be implemented. BranchSearchRecord getBranchSearchRecord(Type branchSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.branchSearchRecordType
- a branch search record typeNullArgumentException
- branchSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordTypeType(branchSearchRecordType)
is
false
mandatory
- This method must be implemented.