org.osid.financials

Interface ActivitySearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface ActivitySearchOrder
extends OsidObjectSearchOrder, OsidFederateableSearchOrder, OsidTemporalSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ActivitySearchOrderRecord	getActivitySearchOrderRecord(Type activityRecordType) Gets the activity search order record corresponding to the given activity record Type.
ResourceSearchOrder	getOrganizationSearchOrder() Gets the resource search order.
ResourceSearchOrder	getSupervisorSearchOrder() Gets the resource search order.
void	orderByCode(SearchOrderStyle style) Specifies a preference for ordering the result set by the code.
void	orderByOrganization(SearchOrderStyle style) Specifies a preference for ordering the result set by the organization.
void	orderBySupervisor(SearchOrderStyle style) Specifies a preference for ordering the result set by the supervisor.
boolean	supportsOrganizationSearchOrder() Tests if a ResourceSearchOrder is available.
boolean	supportsSupervisorSearchOrder() Tests if a ResourceSearchOrder is available.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByOrganization

void orderByOrganization(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsOrganizationSearchOrder

boolean supportsOrganizationSearchOrder()

Tests if a ResourceSearchOrder is available.

Returns:

true if a resource search order is available, false otherwise

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getOrganizationSearchOrder

ResourceSearchOrder getOrganizationSearchOrder()

Gets the resource search order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsOrganizationSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsOrganizationSearchOrder() is true.

orderBySupervisor

void orderBySupervisor(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSupervisorSearchOrder

boolean supportsSupervisorSearchOrder()

Tests if a ResourceSearchOrder is available.

Returns:

true if a resource search order is available, false otherwise

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getSupervisorSearchOrder

ResourceSearchOrder getSupervisorSearchOrder()

Gets the resource search order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsSupervisorSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsSupervisorSearchOrder() is true.

orderByCode

void orderByCode(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getActivitySearchOrderRecord

ActivitySearchOrderRecord getActivitySearchOrderRecord(Type activityRecordType)
                                                       throws OperationFailedException

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

Parameters:

activityRecordType - an activity record type

Returns:

the activity search order record

Throws:

NullArgumentException - activityRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityRecordType) is false

Compliance:

mandatory - This method must be implemented.