OSID Logo
OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.RelationshipSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderBySource
Description

Specifies a preference for ordering the result set by the source peer.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByDestination
Description

Specifies a preference for ordering the result set by the destination peer.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipSearchOrderRecord
Description

Gets the relationship search order record corresponding to the given relationship record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TyperelationshipRecordTypea relationship record type
Returnosid.relationship.records.RelationshipSearchOrderRecordthe relationship search order record
ErrorsNULL_ARGUMENT relationshipRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(relationshipRecordType) is false
CompliancemandatoryThis method must be implemented.