Interface BranchSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BranchSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getBranches

BranchList getBranches()

Gets the branch list resulting from a search.

Returns:

the branch list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getBranchQueryInspector

BranchQueryInspector getBranchQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the branch query inspector

Compliance:

mandatory - This method must be implemented.

getBranchSearchResultsRecord

BranchSearchResultsRecord getBranchSearchResultsRecord(Type branchSearchRecordType)
                                                throws OperationFailedException,
PermissionDeniedException

Gets the branch search results 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 results record

Throws:

NullArgumentException - branchSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordTypeType(branchSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.