OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.ActivitySearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidFederateableSearchOrder
osid.OsidTemporalSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByOrganization
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationSearchOrder
Description

Tests if a ResourceSearchOrder is available.

Returnboolean true if a resource search order is available, false otherwise
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetOrganizationSearchOrder
Description

Gets the resource search order.

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

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsSupervisorSearchOrder
Description

Tests if a ResourceSearchOrder is available.

Returnboolean true if a resource search order is available, false otherwise
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetSupervisorSearchOrder
Description

Gets the resource search order.

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

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetActivitySearchOrderRecord
Description

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

Parametersosid.type.TypeactivityRecordTypean activity record type
Returnosid.financials.records.ActivitySearchOrderRecordthe activity search order record
ErrorsNULL_ARGUMENT activityRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityRecordType) is false
CompliancemandatoryThis method must be implemented.