public interface CanonicalUnitProcessorSearch extends OsidSearch
The search interface for governing canonical unit processor searches.
Modifier and Type | Method and Description |
---|---|
CanonicalUnitProcessorSearchRecord |
getCanonicalUnitProcessorSearchRecord(Type canonicalUnitProcessorSearchRecordType)
Gets the canonical unit processor search record corresponding to the
given canonical unit processor search record
Type. |
void |
orderCanonicalUnitProcessorResults(CanonicalUnitProcessorSearchOrder canonicalUnitProcessorSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCanonicalUnitProcessors(IdList canonicalUnitProcessorIds)
Execute this search among the given list of canonical unit processors.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCanonicalUnitProcessors(IdList canonicalUnitProcessorIds)
canonicalUnitProcessorIds
- list of canonical unit processorsNullArgumentException
-
canonicalUnitProcessorIds
is null
mandatory
- This method must be implemented. void orderCanonicalUnitProcessorResults(CanonicalUnitProcessorSearchOrder canonicalUnitProcessorSearchOrder)
canonicalUnitProcessorSearchOrder
- canonical unit processor
search orderNullArgumentException
-
canonicalUnitProcessorSearchOrder
is null
UnsupportedException
-
canonicalUnitProcessorSearchOrder
is not of this
servicemandatory
- This method must be implemented. CanonicalUnitProcessorSearchRecord getCanonicalUnitProcessorSearchRecord(Type canonicalUnitProcessorSearchRecordType) throws OperationFailedException
Type.
This
method is used to retrieve an object implementing the requested
record.canonicalUnitProcessorSearchRecordType
- a canonical unit
processor search record typeNullArgumentException
-
canonicalUnitProcessorSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(canonicalUnitProcessorSearchRecordType)
is false
mandatory
- This method must be implemented.