OSID Logo
OSID Specifications
relationship package
Version 3.1.0
Interfaceosid.relationship.RelationshipSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Used Byosid.relationship.RelationshipSearchSession
osid.relationship.RelationshipSmartFamilySession
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.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByDestination
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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.TyperelationshipRecordType a relationship record type
Returnosid.relationship.records.RelationshipSearchOrderRecord the relationship search order record
ErrorsNULL_ARGUMENT relationshipRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(relationshipRecordType) is false
Compliancemandatory This method must be implemented.