public interface CanonicalUnitEnablerSearch extends OsidSearch
The search interface for governing canonical unit enabler searches.
Modifier and Type | Method and Description |
---|---|
CanonicalUnitEnablerSearchRecord |
getCanonicalUnitEnablerSearchRecord(Type canonicalUnitEnablerSearchRecordType)
Gets the canonical unit enabler search record corresponding to the
given canonical unit enabler search record
Type. |
void |
orderCanonicalUnitEnablerResults(CanonicalUnitEnablerSearchOrder canonicalUnitEnablerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCanonicalUnitEnablers(IdList canonicalUnitEnablerIds)
Execute this search among the given list of canonical unit enablers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCanonicalUnitEnablers(IdList canonicalUnitEnablerIds)
canonicalUnitEnablerIds
- list of canonical unit enablersNullArgumentException
- canonicalUnitEnablerIds
is null
mandatory
- This method must be implemented. void orderCanonicalUnitEnablerResults(CanonicalUnitEnablerSearchOrder canonicalUnitEnablerSearchOrder)
canonicalUnitEnablerSearchOrder
- canonical unit enabler search
orderNullArgumentException
-
canonicalUnitEnablerSearchOrder
is null
UnsupportedException
-
canonicalUnitEnablerSearchOrder
is not of this servicemandatory
- This method must be implemented. CanonicalUnitEnablerSearchRecord getCanonicalUnitEnablerSearchRecord(Type canonicalUnitEnablerSearchRecordType) throws OperationFailedException
Type.
This
method is used to retrieve an object implementing the requested
record.canonicalUnitEnablerSearchRecordType
- a canonical unit enabler
search record typeNullArgumentException
-
canonicalUnitEnablerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(canonicalUnitEnablerSearchRecordType)
is
false
mandatory
- This method must be implemented.