Interface HierarchySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface HierarchySearch
extends OsidSearch

HierarchySearch defines the interface for specifying hierarchy search options.

Method Summary

Modifier and Type	Method	Description
HierarchySearchRecord	getHierarchySearchRecord(Type hierarchySearchRecordType)	Gets the hierarchy search record corresponding to the given hierarchy search record Type.
void	orderHierarchyResults(HierarchySearchOrder hierarchySearchOrder)	Specify an ordering to the search results.
void	searchAmongHierarchies(IdList hierarchyIds)	Execute this search using a given list of hierarchies.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongHierarchies

void searchAmongHierarchies(IdList hierarchyIds)

Execute this search using a given list of hierarchies.

Parameters:

hierarchyIds - list of hierarchies

Throws:

NullArgumentException - hierarchyIds is null

Compliance:

mandatory - This method must be implemented.

orderHierarchyResults

void orderHierarchyResults(HierarchySearchOrder hierarchySearchOrder)

Specify an ordering to the search results.

Parameters:

hierarchySearchOrder - hierarchy search order

Throws:

NullArgumentException - hierarchySearchOrder is null

UnsupportedException - hierarchySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getHierarchySearchRecord

HierarchySearchRecord getHierarchySearchRecord(Type hierarchySearchRecordType)
                                        throws OperationFailedException

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

Throws:

NullArgumentException - hierarchySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(hierarchyRecordType) is false

Compliance:

mandatory - This method must be implemented.