Interface | osid.personnel.RealmSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing realm searches. | ||
Method | searchAmongRealms | ||
Description |
Execute this search among the given list of realms. | ||
Parameters | osid.id.IdList | realmIds | list of realms |
Errors | NULL_ARGUMENT | realmIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderRealmResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.personnel.RealmSearchOrder | realmSearchOrder | realm search order |
Errors | NULL_ARGUMENT | realmSearchOrder is null | |
UNSUPPORTED | realmSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRealmSearchRecord | ||
Description |
Gets the record corresponding to the given realm search
record | ||
Parameters | osid.type.Type | realmSearchRecordType | a realm search record type |
Return | osid.personnel.records.RealmSearchRecord | the realm search record | |
Errors | NULL_ARGUMENT | realmSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(realmSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |