public interface AssetSearchOrder extends OsidObjectSearchOrder, OsidAggregateableSearchOrder, OsidSourceableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
AssetSearchOrderRecord |
getAssetSearchOrderRecord(Type assetRecordType)
Gets the asset search order record corresponding to the given asset
record
Type. |
ResourceSearchOrder |
getSourceSearchOrder()
Gets the source order.
|
void |
orderByCopyright(SearchOrderStyle style)
Specifies a preference for grouping the result set by copyright.
|
void |
orderByCopyrightRegistration(SearchOrderStyle style)
Specifies a preference for grouping the result set by copyright
registration.
|
void |
orderByCreatedDate(SearchOrderStyle style)
Specifies a preference for ordering the result set by created date.
|
void |
orderByDistributeAlterations(SearchOrderStyle style)
Specifies a preference for grouping the result set by the ability to
distribute alterations.
|
void |
orderByDistributeCompositions(SearchOrderStyle style)
Specifies a preference for grouping the result set by the ability to
distribute compositions.
|
void |
orderByDistributeVerbatim(SearchOrderStyle style)
Specifies a preference for grouping the result set by the ability to
distribute copies.
|
void |
orderByPrincipalCreditString(SearchOrderStyle style)
Specifies a preference for ordering the result set by the principal
credit string.
|
void |
orderByPublicDomain(SearchOrderStyle style)
Specifies a preference for grouping the result set by published
domain.
|
void |
orderByPublished(SearchOrderStyle style)
Specifies a preference for grouping the result set by published
status.
|
void |
orderByPublishedDate(SearchOrderStyle style)
Specifies a preference for ordering the result set by published date.
|
void |
orderBySource(SearchOrderStyle style)
Specifies a preference for ordering the result set by asset source.
|
void |
orderByTemporalCoverage(SearchOrderStyle style)
Specifies a preference for ordering the result set by temporal
coverage.
|
void |
orderByTitle(SearchOrderStyle style)
Specifies a preference for ordering the result set by asset title.
|
boolean |
supportsSourceSearchOrder()
Tests if a source order interface is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder
void orderByTitle(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByPublicDomain(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCopyright(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCopyrightRegistration(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDistributeVerbatim(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDistributeAlterations(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDistributeCompositions(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderBySource(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSourceSearchOrder()
true
if a source search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getSourceSearchOrder()
UnimplementedException
-
supportsSourceSearchOrder()
is false
optional
- This method must be implemented if
supportsSourceSearchOrder()
is true.
void orderByCreatedDate(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByPublished(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByPublishedDate(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByPrincipalCreditString(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByTemporalCoverage(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. AssetSearchOrderRecord getAssetSearchOrderRecord(Type assetRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.assetRecordType
- an asset record typeNullArgumentException
- assetRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(assetRecordType)
is false
mandatory
- This method must be implemented.