Interface HierarchySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface HierarchySearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
HierarchyList	getHierarchies()	Gets the hierarchy list resulting from the search.
HierarchyQueryInspector	getHierarchyQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
HierarchySearchResultsRecord	getHierarchySearchResultsRecord(Type hierarchySearchRecordType)	Gets the hierarchy search results record corresponding to the given hierarchy 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

getHierarchies

HierarchyList getHierarchies()

Gets the hierarchy list resulting from the search.

Returns:

the hierarchy list

Throws:

IllegalStateException - the hierarchy list was already retrieved

Compliance:

mandatory - This method must be implemented.

getHierarchyQueryInspector

HierarchyQueryInspector getHierarchyQueryInspector()

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

Returns:

the hierarchy query inspector

Compliance:

mandatory - This method must be implemented.

getHierarchySearchResultsRecord

HierarchySearchResultsRecord getHierarchySearchResultsRecord(Type hierarchySearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

hierarchySearchRecordType - a hierarchy search record type

Returns:

the hierarchy search results record

Throws:

NullArgumentException - hierarchySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(hierarchySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.