public interface SubjectSearch extends OsidSearch
SubjectSearch
defines the interface for specifying
subject search options.
Modifier and Type | Method and Description |
---|---|
SubjectSearchRecord |
getSubjectSearchRecord(Type subjectSearchRecordType)
Gets the subject search record corresponding to the given subject
search record
Type. |
void |
orderSubjectResults(SubjectSearchOrder subjectSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongSubjects(IdList subjectIds)
Execute this search among the given list of subjects.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongSubjects(IdList subjectIds)
subjectIds
- list of subjectsNullArgumentException
- subjectIds
is
null
mandatory
- This method must be implemented. void orderSubjectResults(SubjectSearchOrder subjectSearchOrder)
subjectSearchOrder
- subject search orderNullArgumentException
- subjectSearchOrder
is null
UnsupportedException
- subjectSearchOrder
is not of this servicemandatory
- This method must be implemented. SubjectSearchRecord getSubjectSearchRecord(Type subjectSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.subjectSearchRecordType
- a subject search record typeNullArgumentException
- subjectSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(subjectSearchRecordType)
is false
mandatory
- This method must be implemented.