public interface PackageQuery extends OsidObjectQuery, OsidSourceableQuery
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.
Modifier and Type | Method and Description |
---|---|
void |
clearCopyrightTerms()
Clears the copyright query terms.
|
void |
clearCreatorIdTerms()
Clears the creator
Id query terms. |
void |
clearCreatorTerms()
Clears the creator query terms.
|
void |
clearDependencyIdTerms()
Clears the dependency
Id query terms. |
void |
clearDependencyTerms()
Clears the dependency query terms.
|
void |
clearDependentIdTerms()
Clears the dependent
Id query terms. |
void |
clearDependentTerms()
Clears the dependent query terms.
|
void |
clearDepotIdTerms()
Clears the depot
Id query terms. |
void |
clearDepotTerms()
Clears the depot query terms.
|
void |
clearInstallationContentIdTerms()
Clears the installation content
Id terms. |
void |
clearInstallationContentTerms()
Clears the installation content terms.
|
void |
clearInstallationIdTerms()
Clears the installation
Id query terms. |
void |
clearInstallationTerms()
Clears the installation query terms.
|
void |
clearReleaseDateTerms()
Clears the release date query terms.
|
void |
clearRequiresLicenseAcknowledgementTerms()
Clears the license acknowledgement query terms.
|
void |
clearURLTerms()
Clears the url query terms.
|
void |
clearVersionedPackageIdTerms()
Clears the versioned package
Id query terms. |
void |
clearVersionedPackageTerms()
Clears the versioned package query terms.
|
void |
clearVersionSinceTerms()
Clears the version since query terms.
|
void |
clearVersionTerms()
Clears the version query terms.
|
ResourceQuery |
getCreatorQuery()
Gets the query for a creator resource.
|
PackageQuery |
getDependencyQuery()
Gets the query for a dependency.
|
PackageQuery |
getDependentQuery()
Gets the query for a dependent.
|
DepotQuery |
getDepotQuery()
Gets the query for a depot.
|
InstallationContentQuery |
getInstallationContentQuery()
Gets the query for the installation content.
|
InstallationQuery |
getInstallationQuery()
Gets the query for an installation.
|
PackageQueryRecord |
getPackageQueryRecord(Type packageRecordType)
Gets the package query record corresponding to the given
Package record Type. |
PackageQuery |
getVersionedPackageQuery()
Gets the query for a version chain.
|
void |
matchAnyCopyright(boolean match)
Matches packages with any copyright.
|
void |
matchAnyCreator(boolean match)
Matches packages with any creator.
|
void |
matchAnyDependency(boolean match)
Matches packages that have any dependency.
|
void |
matchAnyDependent(boolean match)
Matches packages that have any depenents.
|
void |
matchAnyInstallation(boolean match)
Matches any packages that are installed.
|
void |
matchAnyInstallationContent(boolean match)
Matches packages with any content.
|
void |
matchAnyReleaseDate(boolean match)
Matches packages that have any release date.
|
void |
matchAnyRequiresLicenseAcknowledgement(boolean match)
Matches packages that have any acknowledgement value.
|
void |
matchAnyURL(boolean match)
Matches packages that have any url.
|
void |
matchAnyVersion(boolean match)
Matches packages with any version.
|
void |
matchAnyVersionedPackage(boolean match)
Matches packages that have any versions.
|
void |
matchCopyright(java.lang.String copyright,
Type stringMatchType,
boolean match)
Matches the copyright.
|
void |
matchCreatorId(Id resourceId,
boolean match)
Sets the creator resource
Id for this query. |
void |
matchDependencyId(Id packageId,
boolean match)
Sets the package
Id to match packages on which a
package depends. |
void |
matchDependentId(Id packageId,
boolean match)
Sets the package
Id to match packages on which other
packages depend. |
void |
matchDepotId(Id depotId,
boolean match)
Sets the depot
Id for this query. |
void |
matchInstallationContentId(Id installationContentId,
boolean match)
Sets the installation content
Id for this query. |
void |
matchInstallationId(Id installationId,
boolean match)
Sets the installation
Id for this query. |
void |
matchReleaseDate(DateTime from,
DateTime to,
boolean match)
Matches the release date between the given times inclusive.
|
void |
matchRequiresLicenseAcknowledgement(boolean match)
Matches packages that require license acknowledgement.
|
void |
matchURL(java.lang.String url,
Type stringMatchType,
boolean match)
Sets the url for this query.
|
void |
matchVersion(Version version,
boolean match)
Matches a version.
|
void |
matchVersionedPackageId(Id packageId,
boolean match)
Sets the package
Id to match packages in the version
chain. |
void |
matchVersionSince(Version version,
boolean match)
Matches packages with versions including and more recent than the
given version.
|
boolean |
supportsCreatorQuery()
Tests if a
ResourceQuery is available for querying
creators. |
boolean |
supportsDependencyQuery()
Tests if a
PackageQuery is available. |
boolean |
supportsDependentQuery()
Tests if a
PackageQuery is available. |
boolean |
supportsDepotQuery()
Tests if a
DepotQuery is available for querying
resources. |
boolean |
supportsInstallationContentQuery()
Tests if an
InstallationContentQuery is available. |
boolean |
supportsInstallationQuery()
Tests if an
InstallationQuery is available. |
boolean |
supportsVersionedPackageQuery()
Tests if a
PackageQuery is available. |
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchVersion(Version version, boolean match)
version
- the versionmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- version
or
stringMatchType
is null
UnsupportedException
- version type not supportedmandatory
- This method must be implemented. void matchAnyVersion(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearVersionTerms()
mandatory
- This method must be implemented. void matchVersionSince(Version version, boolean match)
version
- the versionmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- version
or
stringMatchType
is null
UnsupportedException
- version type not supportedmandatory
- This method must be implemented. void clearVersionSinceTerms()
mandatory
- This method must be implemented. void matchCopyright(java.lang.String copyright, Type stringMatchType, boolean match)
copyright
- copyright stringstringMatchType
- string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- copyright
is
not of stringMatchType
NullArgumentException
- copyright
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyCopyright(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearCopyrightTerms()
mandatory
- This method must be implemented. void matchRequiresLicenseAcknowledgement(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyRequiresLicenseAcknowledgement(boolean match)
match
- true
to match packages that have any
acknowledgement value, false
for to match
packages that have no valuemandatory
- This method must be implemented. void clearRequiresLicenseAcknowledgementTerms()
mandatory
- This method must be implemented. void matchCreatorId(Id resourceId, boolean match)
Id
for this query.resourceId
- a resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearCreatorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsCreatorQuery()
ResourceQuery
is available for querying
creators. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getCreatorQuery()
OR
term.UnimplementedException
- supportsCreatorQuery()
is false
optional
- This method must be implemented if
supportsCreatorQuery()
is true.
void matchAnyCreator(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearCreatorTerms()
mandatory
- This method must be implemented. void matchReleaseDate(DateTime from, DateTime to, boolean match)
from
- starting rangeto
- ending rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
is
less than from
mandatory
- This method must be implemented. void matchAnyReleaseDate(boolean match)
match
- true
to match packages with any release
date, false
to match packages with no release
datemandatory
- This method must be implemented. void clearReleaseDateTerms()
mandatory
- This method must be implemented. void matchDependencyId(Id packageId, boolean match)
Id
to match packages on which a
package depends.packageId
- a state Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stateId
is
null
mandatory
- This method must be implemented. void clearDependencyIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDependencyQuery()
PackageQuery
is available. true
if a package query is available,
false
otherwisemandatory
- This method must be implemented. PackageQuery getDependencyQuery()
OR
term.UnimplementedException
-
supportsDependencyQuery()
is false
optional
- This method must be implemented if
supportsDependencyQuery()
is true.
void matchAnyDependency(boolean match)
match
- true
to match packages with any
dependency, false
to match packages with no
dependenciesmandatory
- This method must be implemented. void clearDependencyTerms()
mandatory
- This method must be implemented. void matchURL(java.lang.String url, Type stringMatchType, boolean match)
OR
among the elements each which must
correspond to the stringMatchType.
url
- url string to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- url
not of
stringMatchType
NullArgumentException
- url
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(url)
is false
mandatory
- This method must be implemented. void matchAnyURL(boolean match)
match
- true
to match packages with any url,
false
to match packages with no urlmandatory
- This method must be implemented. void clearURLTerms()
mandatory
- This method must be implemented. void matchInstallationId(Id installationId, boolean match)
Id
for this query.installationId
- an installation Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- installationId
is null
mandatory
- This method must be implemented. void clearInstallationIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsInstallationQuery()
InstallationQuery
is available. true
if an installation query is available,
false
otherwisemandatory
- This method must be implemented. InstallationQuery getInstallationQuery()
OR
term.UnimplementedException
-
supportsInstallationQuery()
is false
optional
- This method must be implemented if
supportsInstallationQuery()
is true.
void matchAnyInstallation(boolean match)
match
- true
to match installed packages,
false
for uninstalled packagesmandatory
- This method must be implemented. void clearInstallationTerms()
mandatory
- This method must be implemented. void matchDependentId(Id packageId, boolean match)
Id
to match packages on which other
packages depend.packageId
- a package Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stateId
is
null
mandatory
- This method must be implemented. void clearDependentIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDependentQuery()
PackageQuery
is available. true
if a package query is available,
false
otherwisemandatory
- This method must be implemented. PackageQuery getDependentQuery()
OR
term.UnimplementedException
-
supportsDependentQuery()
is false
optional
- This method must be implemented if
supportsDependentQuery()
is true.
void matchAnyDependent(boolean match)
match
- true
to match packages with any
dependents, false
to match packages with no
dependentsmandatory
- This method must be implemented. void clearDependentTerms()
mandatory
- This method must be implemented. void matchVersionedPackageId(Id packageId, boolean match)
Id
to match packages in the version
chain.packageId
- a state Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- packageId
is
null
mandatory
- This method must be implemented. void clearVersionedPackageIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsVersionedPackageQuery()
PackageQuery
is available. true
if a package query is available,
false
otherwisemandatory
- This method must be implemented. PackageQuery getVersionedPackageQuery()
OR
term.UnimplementedException
- supportsVersionQuery()
is false
optional
- This method must be implemented if
supportsVersionQuery()
is true.
void matchAnyVersionedPackage(boolean match)
match
- true
to match packages with any versions,
false
to match packages with no versionsmandatory
- This method must be implemented. void clearVersionedPackageTerms()
mandatory
- This method must be implemented. void matchInstallationContentId(Id installationContentId, boolean match)
Id
for this query.installationContentId
- the installation content Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- installationContentId
is null
mandatory
- This method must be implemented. void clearInstallationContentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsInstallationContentQuery()
InstallationContentQuery
is available. true
if an installation content query is
available, false
otherwisemandatory
- This method must be implemented. InstallationContentQuery getInstallationContentQuery()
OR
term.UnimplementedException
-
supportsInstallationContentQuery()
is false
optional
- This method must be implemented if
supportsInstallationContentQuery()
is true.
void matchAnyInstallationContent(boolean match)
match
- true
to match packages with any content,
false
to match packages with no contentmandatory
- This method must be implemented. void clearInstallationContentTerms()
mandatory
- This method must be implemented. void matchDepotId(Id depotId, boolean match)
Id
for this query.depotId
- a depot Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- depotId
is
null
mandatory
- This method must be implemented. void clearDepotIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDepotQuery()
DepotQuery
is available for querying
resources. true
if a depot query is available,
false
otherwisemandatory
- This method must be implemented. DepotQuery getDepotQuery()
OR
term.UnimplementedException
- supportsDepotQuery()
is false
optional
- This method must be implemented if
supportsDepotQuery()
is true.
void clearDepotTerms()
mandatory
- This method must be implemented. PackageQueryRecord getPackageQueryRecord(Type packageRecordType) throws OperationFailedException
Package
record Type.
Multiple retrievals
produce a nested OR
term.packageRecordType
- a package query record typeNullArgumentException
- packageRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(packageRecordType)
is false
mandatory
- This method must be implemented.