public interface OfficeSearch extends OsidSearch
The search interface for governing office searches.
Modifier and Type | Method and Description |
---|---|
OfficeSearchRecord |
getOfficeSearchRecord(Type officeSearchRecordType)
Gets the office search record corresponding to the given office search
record
Type. |
void |
orderOfficeResults(OfficeSearchOrder officeSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongOffices(IdList officeIds)
Execute this search among the given list of offices.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongOffices(IdList officeIds)
officeIds
- list of officesNullArgumentException
- officeIds
is
null
mandatory
- This method must be implemented. void orderOfficeResults(OfficeSearchOrder officeSearchOrder)
officeSearchOrder
- office search orderNullArgumentException
- officeSearchOrder
is null
UnsupportedException
- officeSearchOrder
is not of this servicemandatory
- This method must be implemented. OfficeSearchRecord getOfficeSearchRecord(Type officeSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.officeSearchRecordType
- a office search record typeNullArgumentException
- officeSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(officeSearchRecordType)
is false
mandatory
- This method must be implemented.