| Interface | osid.profile.ProfileSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The interface for governing profile searches. | ||
| Method | searchAmongProfiles | ||
| Description |
Execute this search among the given list of profiles. | ||
| Parameters | osid.id.IdList | profileIds | list of profiles |
| Errors | NULL_ARGUMENT | profileIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderProfileResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.profile.ProfileSearchOrder | profileSearchOrder | profile search order |
| Errors | NULL_ARGUMENT | profileSearchOrder is null | |
| UNSUPPORTED | profileSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getProfileSearchRecord | ||
| Description |
Gets the profile search record corresponding to the
given profile search record | ||
| Parameters | osid.type.Type | profileSearchRecordType | a profile search record type |
| Return | osid.profile.records.ProfileSearchRecord | the profile search record | |
| Errors | NULL_ARGUMENT | profileSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(profileSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |