OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalEntrySearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSubjugateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByBranch
Description

Specifies a preference for ordering the result set by the branch.

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

Tests if a branch search order is available.

Returnboolean true if a branch order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBranchSearchOrder
Description

Gets the branch search order.

Returnosid.journaling.BranchSearchOrderthe branch search order
ErrorsUNIMPLEMENTED supportsBranchSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsBranchSearchOrder() is true.
MethodorderBySource
Description

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

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

Specifies a preference for ordering the result set by the timestamp.

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

Specifies a preference for ordering the result set by the resource.

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

Tests if a resource order is available.

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

Gets the resource order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsResourceSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAgentSearchOrder() is true.
MethodorderByAgent
Description

Specifies a preference for ordering the result set by the agent.

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

Tests if an agent order is available.

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

Gets the agent order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsUNIMPLEMENTED supportsAgentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAgentSearchOrder() is true.
MethodgetJournalEntrySearchOrderRecord
Description

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

Parametersosid.type.TypejournalEntryRecordTypea journal entry record type
Returnosid.journaling.records.JournalEntrySearchOrderRecordthe journal entry search order record
ErrorsNULL_ARGUMENT journalEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(journalEntryRecordType) is false
CompliancemandatoryThis method must be implemented.