OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.ResourceRelationshipSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderBySourceResource
Description

Specified a preference for ordering results by the resource.

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

Tests if a ResourceSearchOrder is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSourceResourceSearchOrder
Description

Gets the search order for a resource.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsSourceResourceSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsSourceResourceSearchOrder() is true.
MethodorderByDestinationResource
Description

Specified a preference for ordering results by the resource.

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

Tests if a ResourceSearchOrder is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDestinationResourceSearchOrder
Description

Gets the search order for a peer resource.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsDestinationResourceSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsDestinationResourceSearchOrder() is true.
MethodgetResourceRelationshipSearchOrderRecord
Description

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

Parametersosid.type.TyperesourceRelationshipRecordTypea resource relationship record type
Returnosid.resource.records.ResourceRelationshipSearchOrderRecordthe resource relationship search order record
ErrorsNULL_ARGUMENT resourceRelationshipRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(ResourceRelationshipRecordType) is false
CompliancemandatoryThis method must be implemented.