org.osid.hierarchy

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

Methods

Modifier and Type	Method and 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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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.