OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.PackageQuery
Implementsosid.OsidObjectQuery
osid.OsidSourceableQuery
Description

This is the query for searching packages. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

MethodmatchVersion
Description

Matches a version.

Parametersosid.installation.Versionversionthe version
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT version or stringMatchType is null
UNSUPPORTEDversion type not supported
CompliancemandatoryThis method must be implemented.
MethodmatchAnyVersion
Description

Matches packages with any version.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearVersionTerms
Description

Clears the version query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchVersionSince
Description

Matches packages with versions including and more recent than the given version.

Parametersosid.installation.Versionversionthe version
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT version or stringMatchType is null
UNSUPPORTEDversion type not supported
CompliancemandatoryThis method must be implemented.
MethodclearVersionSinceTerms
Description

Clears the version since query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCopyright
Description

Matches the copyright.

Parametersstringcopyrightcopyright string
osid.type.TypestringMatchTypestring match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT copyright is not of stringMatchType
NULL_ARGUMENT copyright or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyCopyright
Description

Matches packages with any copyright.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearCopyrightTerms
Description

Clears the copyright query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRequiresLicenseAcknowledgement
Description

Matches packages that require license acknowledgement.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyRequiresLicenseAcknowledgement
Description

Matches packages that have any acknowledgement value.

Parametersbooleanmatch true to match packages that have any acknowledgement value, false for to match packages that have no value
CompliancemandatoryThis method must be implemented.
MethodclearRequiresLicenseAcknowledgementTerms
Description

Clears the license acknowledgement query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCreatorId
Description

Sets the creator resource Id for this query.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearCreatorIdTerms
Description

Clears the creator Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCreatorQuery
Description

Tests if a ResourceQuery is available for querying creators.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCreatorQuery
Description

Gets the query for a creator resource. Multiple retrievals produce a nested OR term.

Returnosid.resource.ResourceQuerythe creator resource query
ErrorsUNIMPLEMENTED supportsCreatorQuery() is false
ComplianceoptionalThis method must be implemented if supportsCreatorQuery() is true.
MethodmatchAnyCreator
Description

Matches packages with any creator.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearCreatorTerms
Description

Clears the creator query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchReleaseDate
Description

Matches the release date between the given times inclusive.

Parametersosid.calendaring.DateTimefromstarting range
osid.calendaring.DateTimetoending range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT to is less than from
CompliancemandatoryThis method must be implemented.
MethodmatchAnyReleaseDate
Description

Matches packages that have any release date.

Parametersbooleanmatch true to match packages with any release date, false to match packages with no release date
CompliancemandatoryThis method must be implemented.
MethodclearReleaseDateTerms
Description

Clears the release date query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDependencyId
Description

Sets the package Id to match packages on which a package depends.

Parametersosid.id.IdpackageIda state Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT stateId is null
CompliancemandatoryThis method must be implemented.
MethodclearDependencyIdTerms
Description

Clears the dependency Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDependencyQuery
Description

Tests if a PackageQuery is available.

Returnboolean true if a package query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDependencyQuery
Description

Gets the query for a dependency. Multiple retrievals produce a nested OR term.

Returnosid.installation.PackageQuerythe package query
ErrorsUNIMPLEMENTED supportsDependencyQuery() is false
ComplianceoptionalThis method must be implemented if supportsDependencyQuery() is true.
MethodmatchAnyDependency
Description

Matches packages that have any dependency.

Parametersbooleanmatch true to match packages with any dependency, false to match packages with no dependencies
CompliancemandatoryThis method must be implemented.
MethodclearDependencyTerms
Description

Clears the dependency query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchURL
Description

Sets the url for this query. Supplying multiple strings behaves like a boolean OR among the elements each which must correspond to the stringMatchType.

Parametersstringurlurl string to match
osid.type.TypestringMatchTypethe string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT url not of stringMatchType
NULL_ARGUMENT url or stringMatchType is null
UNSUPPORTED supportsStringMatchType(url) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyURL
Description

Matches packages that have any url.

Parametersbooleanmatch true to match packages with any url, false to match packages with no url
CompliancemandatoryThis method must be implemented.
MethodclearURLTerms
Description

Clears the url query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInstallationId
Description

Sets the installation Id for this query.

Parametersosid.id.IdinstallationIdan installation Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT installationId is null
CompliancemandatoryThis method must be implemented.
MethodclearInstallationIdTerms
Description

Clears the installation Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInstallationQuery
Description

Tests if an InstallationQuery is available.

Returnboolean true if an installation query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInstallationQuery
Description

Gets the query for an installation. Multiple retrievals produce a nested OR term.

Returnosid.installation.InstallationQuerythe installation query
ErrorsUNIMPLEMENTED supportsInstallationQuery() is false
ComplianceoptionalThis method must be implemented if supportsInstallationQuery() is true.
MethodmatchAnyInstallation
Description

Matches any packages that are installed.

Parametersbooleanmatch true to match installed packages, false for uninstalled packages
CompliancemandatoryThis method must be implemented.
MethodclearInstallationTerms
Description

Clears the installation query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDependentId
Description

Sets the package Id to match packages on which other packages depend.

Parametersosid.id.IdpackageIda package Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT stateId is null
CompliancemandatoryThis method must be implemented.
MethodclearDependentIdTerms
Description

Clears the dependent Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDependentQuery
Description

Tests if a PackageQuery is available.

Returnboolean true if a package query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDependentQuery
Description

Gets the query for a dependent. Multiple retrievals produce a nested OR term.

Returnosid.installation.PackageQuerythe package query
ErrorsUNIMPLEMENTED supportsDependentQuery() is false
ComplianceoptionalThis method must be implemented if supportsDependentQuery() is true.
MethodmatchAnyDependent
Description

Matches packages that have any depenents.

Parametersbooleanmatch true to match packages with any dependents, false to match packages with no dependents
CompliancemandatoryThis method must be implemented.
MethodclearDependentTerms
Description

Clears the dependent query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchVersionedPackageId
Description

Sets the package Id to match packages in the version chain.

Parametersosid.id.IdpackageIda state Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT packageId is null
CompliancemandatoryThis method must be implemented.
MethodclearVersionedPackageIdTerms
Description

Clears the versioned package Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsVersionedPackageQuery
Description

Tests if a PackageQuery is available.

Returnboolean true if a package query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetVersionedPackageQuery
Description

Gets the query for a version chain. Multiple retrievals produce a nested OR term.

Returnosid.installation.PackageQuerythe package query
ErrorsUNIMPLEMENTED supportsVersionQuery() is false
ComplianceoptionalThis method must be implemented if supportsVersionQuery() is true.
MethodmatchAnyVersionedPackage
Description

Matches packages that have any versions.

Parametersbooleanmatch true to match packages with any versions, false to match packages with no versions
CompliancemandatoryThis method must be implemented.
MethodclearVersionedPackageTerms
Description

Clears the versioned package query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInstallationContentId
Description

Sets the installation content Id for this query.

Parametersosid.id.IdinstallationContentIdthe installation content Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT installationContentId is null
CompliancemandatoryThis method must be implemented.
MethodclearInstallationContentIdTerms
Description

Clears the installation content Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInstallationContentQuery
Description

Tests if an InstallationContentQuery is available.

Returnboolean true if an installation content query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInstallationContentQuery
Description

Gets the query for the installation content. Multiple queries can be retrieved for a nested OR term.

Returnosid.installation.InstallationContentQuerythe installation content query
ErrorsUNIMPLEMENTED supportsInstallationContentQuery() is false
ComplianceoptionalThis method must be implemented if supportsInstallationContentQuery() is true.
MethodmatchAnyInstallationContent
Description

Matches packages with any content.

Parametersbooleanmatch true to match packages with any content, false to match packages with no content
CompliancemandatoryThis method must be implemented.
MethodclearInstallationContentTerms
Description

Clears the installation content terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDepotId
Description

Sets the depot Id for this query.

Parametersosid.id.IddepotIda depot Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT depotId is null
CompliancemandatoryThis method must be implemented.
MethodclearDepotIdTerms
Description

Clears the depot Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDepotQuery
Description

Tests if a DepotQuery is available for querying resources.

Returnboolean true if a depot query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDepotQuery
Description

Gets the query for a depot. Multiple retrievals produce a nested OR term.

Returnosid.installation.DepotQuerythe depot query
ErrorsUNIMPLEMENTED supportsDepotQuery() is false
ComplianceoptionalThis method must be implemented if supportsDepotQuery() is true.
MethodclearDepotTerms
Description

Clears the depot query terms.

CompliancemandatoryThis method must be implemented.
MethodgetPackageQueryRecord
Description

Gets the package query record corresponding to the given Package record Type. Multiple retrievals produce a nested OR term.

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