OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.PackageSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSourceableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByVersion
Description

Specified a preference for ordering results by the version.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCopyright
Description

Specified a preference for ordering results by the copyright.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByRequiresLicenseAcknowledgement
Description

Specified a preference for ordering results by the license acknowledgement flag.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCreator
Description

Specified a preference for ordering results by the creator.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCreatorSearchOrder
Description

Tests if a ResourceSearchOrder is available for creator resources.

Returnboolean true if a creator resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCreatorSearchOrder
Description

Gets the search order for a creator resource.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsCreatorSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCreatorSearchOrder() is true.
MethodorderByReleaseDate
Description

Specified a preference for ordering results by the release date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByURL
Description

Specified a preference for ordering results by the url.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetPackageSearchOrderRecord
Description

Gets the package search order record corresponding to the given package record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypepackageRecordTypea package record type
Returnosid.installation.records.PackageSearchOrderRecordthe package search order record
ErrorsNULL_ARGUMENT packageRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(packageRecordType) is false
CompliancemandatoryThis method must be implemented.