public interface BudgetSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ActivitySearchOrder |
getActivitySearchOrder()
Gets the activity search order.
|
BudgetSearchOrderRecord |
getBudgetSearchOrderRecord(Type budgetRecordType)
Gets the budget search order record corresponding to the given budget
record
Type. |
FiscalPeriodSearchOrder |
getFiscalPeriodSearchOrder()
Gets the fiscal period search order.
|
void |
orderByActivity(SearchOrderStyle style)
Specifies a preference for ordering the result set by activity.
|
void |
orderByFiscalPeriod(SearchOrderStyle style)
Specifies a preference for ordering the result set by fiscal period.
|
boolean |
supportsActivitySearchOrder()
Tests if an activity search order is available.
|
boolean |
supportsFiscalPeriodSearchOrder()
Tests if a fiscal period search order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByActivity(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsActivitySearchOrder()
true
if an activity search order is available,
false
otherwisemandatory
- This method must be implemented. ActivitySearchOrder getActivitySearchOrder()
UnimplementedException
-
supportsActivitySearchOrder()
is false
optional
- This method must be implemented if
supportsActivitySearchOrder()
is true.
void orderByFiscalPeriod(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsFiscalPeriodSearchOrder()
true
if a fiscal period search order is
available, false
otherwisemandatory
- This method must be implemented. FiscalPeriodSearchOrder getFiscalPeriodSearchOrder()
UnimplementedException
-
supportsFiscalPeriodSearchOrder()
is false
optional
- This method must be implemented if
supportsFiscalPeriodSearchOrder()
is true.
BudgetSearchOrderRecord getBudgetSearchOrderRecord(Type budgetRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.budgetRecordType
- a budget record typeNullArgumentException
- budgetRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(budgetRecordType)
is false
mandatory
- This method must be implemented.