public interface HierarchySearch extends OsidSearch
HierarchySearch
defines the interface for specifying
hierarchy search options.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongHierarchies(IdList hierarchyIds)
hierarchyIds
- list of hierarchiesNullArgumentException
- hierarchyIds
is
null
mandatory
- This method must be implemented. void orderHierarchyResults(HierarchySearchOrder hierarchySearchOrder)
hierarchySearchOrder
- hierarchy search orderNullArgumentException
- hierarchySearchOrder
is null
UnsupportedException
- hierarchySearchOrder
is not of this servicemandatory
- This method must be implemented. HierarchySearchRecord getHierarchySearchRecord(Type hierarchySearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.hierarchySearchRecordType
- a hierarchy search record typeNullArgumentException
-
hierarchySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(hierarchyRecordType)
is false
mandatory
- This method must be implemented.