Interface | osid.installation.PackageQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidSourceableQuery | |||
Description |
This is the query for searching packages. Each method match
request produces an | ||
Method | matchVersion | ||
Description |
Matches a version. | ||
Parameters | osid.installation.Version | version | the version |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | version or stringMatchType is null
| |
UNSUPPORTED | version type not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyVersion | ||
Description |
Matches packages with any version. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearVersionTerms | ||
Description |
Clears the version query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVersionSince | ||
Description |
Matches packages with versions including and more recent than the given version. | ||
Parameters | osid.installation.Version | version | the version |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | version or stringMatchType is null
| |
UNSUPPORTED | version type not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearVersionSinceTerms | ||
Description |
Clears the version since query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCopyright | ||
Description |
Matches the copyright. | ||
Parameters | string | copyright | copyright string |
osid.type.Type | stringMatchType | string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | copyright is not of stringMatchType | |
NULL_ARGUMENT | copyright or stringMatchType is null
| ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyCopyright | ||
Description |
Matches packages with any copyright. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearCopyrightTerms | ||
Description |
Clears the copyright query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRequiresLicenseAcknowledgement | ||
Description |
Matches packages that require license acknowledgement. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyRequiresLicenseAcknowledgement | ||
Description |
Matches packages that have any acknowledgement value. | ||
Parameters | boolean | match | true to match packages that have any acknowledgement value,
false for to match packages that have no value |
Compliance | mandatory | This method must be implemented. | |
Method | clearRequiresLicenseAcknowledgementTerms | ||
Description |
Clears the license acknowledgement query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCreatorId | ||
Description |
Sets the creator resource | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCreatorIdTerms | ||
Description |
Clears the creator | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreatorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreatorQuery | ||
Description |
Gets the query for a creator resource. Multiple
retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | the creator resource query | |
Errors | UNIMPLEMENTED | supportsCreatorQuery() is false | |
Compliance | optional | This method must be implemented if supportsCreatorQuery() is
true. | |
Method | matchAnyCreator | ||
Description |
Matches packages with any creator. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearCreatorTerms | ||
Description |
Clears the creator query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchReleaseDate | ||
Description |
Matches the release date between the given times inclusive. | ||
Parameters | osid.calendaring.DateTime | from | starting range |
osid.calendaring.DateTime | to | ending range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | to is less than from | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyReleaseDate | ||
Description |
Matches packages that have any release date. | ||
Parameters | boolean | match | true to match packages with any release date, false
to match packages with no release date |
Compliance | mandatory | This method must be implemented. | |
Method | clearReleaseDateTerms | ||
Description |
Clears the release date query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDependencyId | ||
Description |
Sets the package | ||
Parameters | osid.id.Id | packageId | a state Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | stateId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDependencyIdTerms | ||
Description |
Clears the dependency | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDependencyQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a package query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDependencyQuery | ||
Description |
Gets the query for a dependency. Multiple retrievals
produce a nested | ||
Return | osid.installation.PackageQuery | the package query | |
Errors | UNIMPLEMENTED | supportsDependencyQuery() is false | |
Compliance | optional | This method must be implemented if supportsDependencyQuery()
is true. | |
Method | matchAnyDependency | ||
Description |
Matches packages that have any dependency. | ||
Parameters | boolean | match | true to match packages with any dependency, false
to match packages with no dependencies |
Compliance | mandatory | This method must be implemented. | |
Method | clearDependencyTerms | ||
Description |
Clears the dependency query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchURL | ||
Description |
Sets the url for this query. Supplying multiple strings
behaves like a boolean | ||
Parameters | string | url | url string to match |
osid.type.Type | stringMatchType | the string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | url not of stringMatchType | |
NULL_ARGUMENT | url or stringMatchType is null | ||
UNSUPPORTED | supportsStringMatchType(url) is false | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyURL | ||
Description |
Matches packages that have any url. | ||
Parameters | boolean | match | true to match packages with any url, false to
match packages with no url |
Compliance | mandatory | This method must be implemented. | |
Method | clearURLTerms | ||
Description |
Clears the url query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchInstallationId | ||
Description |
Sets the installation | ||
Parameters | osid.id.Id | installationId | an installation Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | installationId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearInstallationIdTerms | ||
Description |
Clears the installation | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsInstallationQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an installation query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstallationQuery | ||
Description |
Gets the query for an installation. Multiple retrievals
produce a nested | ||
Return | osid.installation.InstallationQuery | the installation query | |
Errors | UNIMPLEMENTED | supportsInstallationQuery() is false | |
Compliance | optional | This method must be implemented if supportsInstallationQuery()
is true. | |
Method | matchAnyInstallation | ||
Description |
Matches any packages that are installed. | ||
Parameters | boolean | match | true to match installed packages, false for
uninstalled packages |
Compliance | mandatory | This method must be implemented. | |
Method | clearInstallationTerms | ||
Description |
Clears the installation query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDependentId | ||
Description |
Sets the package | ||
Parameters | osid.id.Id | packageId | a package Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | stateId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDependentIdTerms | ||
Description |
Clears the dependent | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDependentQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a package query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDependentQuery | ||
Description |
Gets the query for a dependent. Multiple retrievals
produce a nested | ||
Return | osid.installation.PackageQuery | the package query | |
Errors | UNIMPLEMENTED | supportsDependentQuery() is false | |
Compliance | optional | This method must be implemented if supportsDependentQuery()
is true. | |
Method | matchAnyDependent | ||
Description |
Matches packages that have any depenents. | ||
Parameters | boolean | match | true to match packages with any dependents, false
to match packages with no dependents |
Compliance | mandatory | This method must be implemented. | |
Method | clearDependentTerms | ||
Description |
Clears the dependent query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVersionedPackageId | ||
Description |
Sets the package | ||
Parameters | osid.id.Id | packageId | a state Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | packageId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearVersionedPackageIdTerms | ||
Description |
Clears the versioned package | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsVersionedPackageQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a package query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getVersionedPackageQuery | ||
Description |
Gets the query for a version chain. Multiple retrievals
produce a nested | ||
Return | osid.installation.PackageQuery | the package query | |
Errors | UNIMPLEMENTED | supportsVersionQuery() is false | |
Compliance | optional | This method must be implemented if supportsVersionQuery() is
true. | |
Method | matchAnyVersionedPackage | ||
Description |
Matches packages that have any versions. | ||
Parameters | boolean | match | true to match packages with any versions, false
to match packages with no versions |
Compliance | mandatory | This method must be implemented. | |
Method | clearVersionedPackageTerms | ||
Description |
Clears the versioned package query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchInstallationContentId | ||
Description |
Sets the installation content | ||
Parameters | osid.id.Id | installationContentId | the installation content Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | installationContentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearInstallationContentIdTerms | ||
Description |
Clears the installation content | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsInstallationContentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an installation content query is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstallationContentQuery | ||
Description |
Gets the query for the installation content. Multiple
queries can be retrieved for a nested | ||
Return | osid.installation.InstallationContentQuery | the installation content query | |
Errors | UNIMPLEMENTED | supportsInstallationContentQuery() is false | |
Compliance | optional | This method must be implemented if
supportsInstallationContentQuery() is true. | |
Method | matchAnyInstallationContent | ||
Description |
Matches packages with any content. | ||
Parameters | boolean | match | true to match packages with any content, false
to match packages with no content |
Compliance | mandatory | This method must be implemented. | |
Method | clearInstallationContentTerms | ||
Description |
Clears the installation content terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDepotId | ||
Description |
Sets the depot | ||
Parameters | osid.id.Id | depotId | a depot Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | depotId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDepotIdTerms | ||
Description |
Clears the depot | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDepotQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a depot query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDepotQuery | ||
Description |
Gets the query for a depot. Multiple retrievals produce
a nested | ||
Return | osid.installation.DepotQuery | the depot query | |
Errors | UNIMPLEMENTED | supportsDepotQuery() is false | |
Compliance | optional | This method must be implemented if supportsDepotQuery() is
true. | |
Method | clearDepotTerms | ||
Description |
Clears the depot query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPackageQueryRecord | ||
Description |
Gets the package query record corresponding to the
given | ||
Parameters | osid.type.Type | packageRecordType | a package query record type |
Return | osid.installation.records.PackageQueryRecord | the package query 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. |