OSID Specifications
repository package
Version 3.1.0
repository package
Version 3.1.0
| Interface | osid.repository.AssetSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidAggregateableSearchOrder | |||
osid.OsidSourceableSearchOrder | |||
| Used By | osid.repository.AssetContentSearchOrder | ||
osid.repository.AssetSearchSession | |||
osid.repository.AssetSmartRepositorySession | |||
osid.resource.ResourceSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByTitle | ||
| Description |
Specifies a preference for ordering the result set by asset title. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByPublicDomain | ||
| Description |
Specifies a preference for grouping the result set by published domain. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCopyright | ||
| Description |
Specifies a preference for grouping the result set by copyright. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCopyrightRegistration | ||
| Description |
Specifies a preference for grouping the result set by copyright registration. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDistributeVerbatim | ||
| Description |
Specifies a preference for grouping the result set by the ability to distribute copies. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDistributeAlterations | ||
| Description |
Specifies a preference for grouping the result set by the ability to distribute alterations. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDistributeCompositions | ||
| Description |
Specifies a preference for grouping the result set by the ability to distribute compositions. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySource | ||
| Description |
Specifies a preference for ordering the result set by asset source. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSourceSearchOrder | ||
| Description |
Tests if a source order interface is available. | ||
| Return | boolean | true if a source search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSourceSearchOrder | ||
| Description |
Gets the source order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order for the source | |
| Errors | UNIMPLEMENTED | supportsSourceSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsSourceSearchOrder() is true. | |
| Method | orderByCreatedDate | ||
| Description |
Specifies a preference for ordering the result set by created date. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByPublished | ||
| Description |
Specifies a preference for grouping the result set by published status. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByPublishedDate | ||
| Description |
Specifies a preference for ordering the result set by published date. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByPrincipalCreditString | ||
| Description |
Specifies a preference for ordering the result set by the principal credits. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByTemporalCoverage | ||
| Description |
Specifies a preference for ordering the result set by temporal coverage. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetSearchOrderRecord | ||
| Description |
Gets the asset search order record corresponding to
the given asset record | ||
| Parameters | osid.type.Type | assetRecordType | an asset record type |
| Return | osid.repository.records.AssetSearchOrderRecord | the asset search order record | |
| Errors | NULL_ARGUMENT | assetRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(assetRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |