OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.DepotQuery
Implementsosid.OsidCatalogQuery
Description

This is the query for searching depots. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchPackageId
Description

Sets the package Id for this query.

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

Clears the package Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPackageQuery
Description

Tests if a PackageQuery is available.

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

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

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

Matches depots that have any package.

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

Clears the package query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorDepotId
Description

Sets the depot Id for this query to match depots that have the specified depot as an ancestor.

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.
MethodclearAncestorDepotIdTerms
Description

Clears the ancestor depot Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorDepotQuery
Description

Tests if a DepotQuery is available.

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

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

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

Matches depots with any ancestor.

Parametersbooleanmatch true to match depots with any ancestor, false to match root depots
CompliancemandatoryThis method must be implemented.
MethodclearAncestorDepotTerms
Description

Clears the ancestor depot query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantDepotId
Description

Sets the depot Id for this query to match depots that have the specified depot as a descendant.

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.
MethodclearDescendantDepotIdTerms
Description

Clears the descendant depot Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantDepotQuery
Description

Tests if a DepotQuery is available.

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

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

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

Matches depots with any descendant.

Parametersbooleanmatch true to match depots with any descendant, false to match leaf depots
CompliancemandatoryThis method must be implemented.
MethodclearDescendantDepotTerms
Description

Clears the descendant depot query terms.

CompliancemandatoryThis method must be implemented.
MethodgetDepotQueryRecord
Description

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

Parametersosid.type.TypedepotRecordTypea depot record type
Returnosid.installation.records.DepotQueryRecordthe depot query record
ErrorsNULL_ARGUMENT depotRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(depotRecordType) is false
CompliancemandatoryThis method must be implemented.