OSID Logo
OSID Specifications
blogging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.blogging.EntrySearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSourceableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByTimestamp
Description

Specifies a preference for ordering entries by time.

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

Specifies a preference for ordering entries by the poster.

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

Tests if a resource order interface is available.

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

Gets the poster resource search order interface.

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

Specifies a preference for ordering entries by the posting agent.

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

Tests if an agent order interface is available.

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

Gets the posting agent order interface.

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

Specifies a preference for ordering entries by subject line.

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

Specifies a preference for ordering entries by summary.

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

Specifies a preference for ordering entries by text.

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

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

Parametersosid.type.TypeentryRecordTypean entry record type
Returnosid.blogging.records.EntrySearchOrderRecordthe entry search order record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(entryRecordType) is false
CompliancemandatoryThis method must be implemented.