public interface ConferralSearch extends OsidSearch
The search interface for governing conferral searches.
Modifier and Type | Method and Description |
---|---|
ConferralSearchRecord |
getConferralSearchRecord(Type conferralSearchRecordType)
Gets the conferral search record corresponding to the given conferral
search record
Type. |
void |
orderConferralResults(ConferralSearchOrder conferralSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongConferrals(IdList conferralIds)
Execute this search among the given list of conferrals.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongConferrals(IdList conferralIds)
conferralIds
- list of conferralsNullArgumentException
- conferralIds
is
null
mandatory
- This method must be implemented. void orderConferralResults(ConferralSearchOrder conferralSearchOrder)
conferralSearchOrder
- conferral search orderNullArgumentException
- conferralSearchOrder
is null
UnsupportedException
- conferralSearchOrder
is not of this servicemandatory
- This method must be implemented. ConferralSearchRecord getConferralSearchRecord(Type conferralSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.conferralSearchRecordType
- a conferral search record typeNullArgumentException
-
conferralSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(conferralSearchRecordType)
is
false
mandatory
- This method must be implemented.