Interface | osid.relationship.RelationshipSearchOrder | ||
---|---|---|---|
Implements | osid.OsidRelationshipSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderBySource | ||
Description |
Specifies a preference for ordering the result set by the source peer. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByDestination | ||
Description |
Specifies a preference for ordering the result set by the destination peer. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipSearchOrderRecord | ||
Description |
Gets the relationship search order record corresponding
to the given relationship record | ||
Parameters | osid.type.Type | relationshipRecordType | a relationship record type |
Return | osid.relationship.records.RelationshipSearchOrderRecord | the relationship search order record | |
Errors | NULL_ARGUMENT | relationshipRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(relationshipRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |