OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.HoldSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByResource
Description

Orders the results by resource.

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

Tests if a resource search order is available.

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

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsILLEGAL_STATE supportsResourceSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByAgent
Description

Orders the results by agent.

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

Tests if an agent search order is available.

Returnboolean true if an agent search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgentSearchOrder
Description

Gets the agent search order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsILLEGAL_STATE supportsAgentSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByIssue
Description

Orders the results by issue.

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

Tests if an issue search order is available.

Returnboolean true if an issue search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetIssueSearchOrder
Description

Gets the issue search order.

Returnosid.hold.IssueSearchOrderthe issue search order
ErrorsILLEGAL_STATE supportsIssueSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodgetHoldSearchOrderRecord
Description

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

Parametersosid.type.TypeholdRecordTypea hold record type
Returnosid.hold.records.HoldSearchOrderRecordthe hold search order record
ErrorsNULL_ARGUMENT holdRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(holdRecordType) is false
CompliancemandatoryThis method must be implemented.