public interface OfferingConstrainerSearchOrder extends OsidConstrainerSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
OfferingConstrainerSearchOrderRecord |
getOfferingConstrainerSearchOrderRecord(Type offeringConstrainerRecordType)
Gets the offering constrainer search order record corresponding to the
given offering constrainer record
Type. |
void |
orderByConstrainResultOptions(SearchOrderStyle style)
Specifies a preference for ordering the result set by the constrain
result options flag.
|
void |
orderByConstrainSponsors(SearchOrderStyle style)
Specifies a preference for ordering the result set by the constrain
sponsors flag.
|
void |
orderByConstrainTimePeriods(SearchOrderStyle style)
Specifies a preference for ordering the result set by the constrain
time periods flag.
|
void |
orderByOverrideCode(SearchOrderStyle style)
Specifies a preference for ordering the result set by the code
override.
|
void |
orderByOverrideDescription(SearchOrderStyle style)
Specifies a preference for ordering the result set by the description
override.
|
void |
orderByOverrideResultOptions(SearchOrderStyle style)
Specifies a preference for ordering the result set by the description
override.
|
void |
orderByOverrideSponsors(SearchOrderStyle style)
Specifies a preference for ordering the result set by the description
override.
|
void |
orderByOverrideTimePeriods(SearchOrderStyle style)
Specifies a preference for ordering the result set by the time periods
override.
|
void |
orderByOverrideTitle(SearchOrderStyle style)
Specifies a preference for ordering the result set by the title
override.
|
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByOverrideDescription(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByOverrideTitle(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByOverrideCode(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByOverrideTimePeriods(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByConstrainTimePeriods(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByOverrideResultOptions(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByConstrainResultOptions(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByOverrideSponsors(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByConstrainSponsors(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. OfferingConstrainerSearchOrderRecord getOfferingConstrainerSearchOrderRecord(Type offeringConstrainerRecordType) throws OperationFailedException
Type.
Multiple
retrievals return the same underlying object.offeringConstrainerRecordType
- an offering constrainer record
typeNullArgumentException
-
offeringConstrainerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offeringConstrainerRecordType)
is
false
mandatory
- This method must be implemented.