public interface BranchSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
BranchList |
getBranches()
Gets the branch list resulting from a search.
|
BranchQueryInspector |
getBranchQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
BranchSearchResultsRecord |
getBranchSearchResultsRecord(Type branchSearchRecordType)
Gets the branch search results record corresponding to the given
branch search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
BranchList getBranches()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. BranchQueryInspector getBranchQueryInspector()
mandatory
- This method must be implemented. BranchSearchResultsRecord getBranchSearchResultsRecord(Type branchSearchRecordType) throws OperationFailedException, PermissionDeniedException
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 requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordTypeType(branchSearchRecordType)
is
false
mandatory
- This method must be implemented.