Interface | osid.installation.PackageSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSourceableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByVersion | ||
Description |
Specified a preference for ordering results by the version. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByCopyright | ||
Description |
Specified a preference for ordering results by the copyright. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByRequiresLicenseAcknowledgement | ||
Description |
Specified a preference for ordering results by the license acknowledgement flag. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByCreator | ||
Description |
Specified a preference for ordering results by the creator. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreatorSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a creator resource search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreatorSearchOrder | ||
Description |
Gets the search order for a creator resource. | ||
Return | osid.resource.ResourceSearchOrder | the resource search order | |
Errors | UNIMPLEMENTED | supportsCreatorSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsCreatorSearchOrder()
is true. | |
Method | orderByReleaseDate | ||
Description |
Specified a preference for ordering results by the release date. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByURL | ||
Description |
Specified a preference for ordering results by the url. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPackageSearchOrderRecord | ||
Description |
Gets the package search order record corresponding to
the given package record | ||
Parameters | osid.type.Type | packageRecordType | a package record type |
Return | osid.installation.records.PackageSearchOrderRecord | the package search order record | |
Errors | NULL_ARGUMENT | packageRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(packageRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |