Interface | osid.financials.ActivitySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing activity searches. | ||
Method | searchAmongActivities | ||
Description |
Execute this search among the given list of activities. | ||
Parameters | osid.id.IdList | activityIds | list of activities |
Errors | NULL_ARGUMENT | activityIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderActivityResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.financials.ActivitySearchOrder | activitySearchOrder | activity search order |
Errors | NULL_ARGUMENT | activitySearchOrder is null | |
UNSUPPORTED | activitySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivitySearchRecord | ||
Description |
Gets the activity search record corresponding to the
given activity search record | ||
Parameters | osid.type.Type | activitySearchRecordType | a activity search record type |
Return | osid.financials.records.ActivitySearchRecord | the activity search record | |
Errors | NULL_ARGUMENT | activitySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(activitySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |