OSID Logo
OSID Specifications
financials package
Version 3.1.0
Interfaceosid.financials.ActivitySearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidFederateableSearchOrder
osid.OsidTemporalSearchOrder
Used Byosid.billing.CustomerSearchOrder
osid.financials.ActivitySearchSession
osid.financials.ActivitySmartBusinessSession
osid.financials.budgeting.BudgetSearchOrder
osid.financials.posting.PostEntrySearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByOrganization
Description

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

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetOrganizationSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrder the resource search order
ErrorsUNIMPLEMENTED supportsOrganizationSearchOrder() is false
Complianceoptional This method must be implemented if supportsOrganizationSearchOrder() is true.
MethodorderBySupervisor
Description

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

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetSupervisorSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrder the resource search order
ErrorsUNIMPLEMENTED supportsSupervisorSearchOrder() is false
Complianceoptional This method must be implemented if supportsSupervisorSearchOrder() is true.
MethodorderByCode
Description

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

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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.TypeactivityRecordType an activity record type
Returnosid.financials.records.ActivitySearchOrderRecord the activity search order record
ErrorsNULL_ARGUMENT activityRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(activityRecordType) is false
Compliancemandatory This method must be implemented.