public interface PlanSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
PlanQueryInspector |
getPlanQueryInspector()
Gets the inspector for the query to examine the terns used in the
search.
|
PlanList |
getPlans()
Gets the plan list resulting from a search.
|
PlanSearchResultsRecord |
getPlanSearchResultsRecord(Type planSearchRecordType)
Gets the plan search results record corresponding to the given plan
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
PlanList getPlans()
IllegalStateException
- list has already been retrievedmandatory
- This method must be implemented. PlanQueryInspector getPlanQueryInspector()
mandatory
- This method must be implemented. PlanSearchResultsRecord getPlanSearchResultsRecord(Type planSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.planSearchRecordType
- a plan search record typeNullArgumentException
- planSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(planSearchRecordType)
is false
mandatory
- This method must be implemented.