public interface QualifierSearch extends OsidSearch
QualifierSearch
defines the interface for specifying
qualifier search options.
Modifier and Type | Method and Description |
---|---|
QualifierSearchRecord |
getQualifierSearchRecord(Type qualifierSearchRecordType)
Gets the qualifier search record corresponding to the given qualifier
search record
Type. |
void |
orderQualifierResults(QualifierSearchOrder qualifierSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongQualifiers(IdList qualifierIds)
Execute this search among the given list of qualifiers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongQualifiers(IdList qualifierIds)
qualifierIds
- list of qualifiersNullArgumentException
- qualifierIds
is
null
mandatory
- This method must be implemented. void orderQualifierResults(QualifierSearchOrder qualifierSearchOrder)
qualifierSearchOrder
- qualifier search orderNullArgumentException
- qualifierSearchOrder
is null
UnsupportedException
- qualifierSearchOrder
is not of this servicemandatory
- This method must be implemented. QualifierSearchRecord getQualifierSearchRecord(Type qualifierSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.qualifierSearchRecordType
- a qualifier search record typeNullArgumentException
-
qualifierSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(qualifierSearchRecordType)
is
false
mandatory
- This method must be implemented.