public interface PeriodSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
PeriodSearchOrderRecord |
getPeriodSearchOrderRecord(Type periodRecordType)
Gets the period search order record corresponding to the given
customer record
Type. |
void |
orderByBillingDate(SearchOrderStyle style)
Specified a preference for ordering results by billing date.
|
void |
orderByCloseDate(SearchOrderStyle style)
Specified a preference for ordering results by close date.
|
void |
orderByDisplayLabel(SearchOrderStyle style)
Specifies a preference for ordering the result set by customer title.
|
void |
orderByDueDate(SearchOrderStyle style)
Specifies a preference for ordering the result set by the due date.
|
void |
orderByOpenDate(SearchOrderStyle style)
Specified a preference for ordering results by the open date.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByDisplayLabel(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByOpenDate(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCloseDate(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByBillingDate(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDueDate(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. PeriodSearchOrderRecord getPeriodSearchOrderRecord(Type periodRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.periodRecordType
- a period record typeNullArgumentException
- periodRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(periodRecordType)
is false
mandatory
- This method must be implemented.