| Interface | osid.relationship.rules.RelationshipEnablerSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing relationship enabler searches. | ||
| Method | searchAmongRelationshipEnablers | ||
| Description |
Execute this search among the given list of relationship enablers. | ||
| Parameters | osid.id.IdList | relationshipEnablerIds | list of relationship enablers |
| Errors | NULL_ARGUMENT | relationshipEnablerIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderRelationshipEnablerResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.relationship.rules.RelationshipEnablerSearchOrder | relationshipEnablerSearchOrder | relationship enabler search order |
| Errors | NULL_ARGUMENT | relationshipEnablerSearchOrder is null | |
| UNSUPPORTED | relationshipEnablerSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelationshipEnablerSearchRecord | ||
| Description |
Gets the relationship enabler search record
corresponding to the given relationship enabler search
record | ||
| Parameters | osid.type.Type | relationshipEnablerSearchRecordType | a relationship enabler search record type |
| Return | osid.relationship.rules.records.RelationshipEnablerSearchRecord | the relationship enabler search record | |
| Errors | NULL_ARGUMENT | relationshipEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(relationshipEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |