org.osid.installation

Interface InstallationQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

public interface InstallationQuery
extends OsidObjectQuery

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAgentIdTerms() Clears the agent Id query terms.
void	clearAgentTerms() Clears the agent query terms.
void	clearInstallDateTerms() Clears the install date query terms.
void	clearLastCheckDateTerms() Clears the last check date query terms.
void	clearPackageIdTerms() Clears the package Id query terms.
void	clearPackageTerms() Clears the package query terms.
void	clearSiteIdTerms() Clears the site Id query terms.
void	clearSiteTerms() Clears the site query terms.
AgentQuery	getAgentQuery() Gets the query for an agent.
InstallationQueryRecord	getInstallationQueryRecord(Type installationRecordType) Gets the installation query record corresponding to the given Installation record Type.
PackageQuery	getPackageQuery() Gets the query for a package.
SiteQuery	getSiteQuery() Gets the query for a site.
void	matchAgentId(Id agentId, boolean match) Sets the agent Id for this query.
void	matchInstallDate(DateTime from, DateTime to, boolean match) Matches the install date between the given times inclusive.
void	matchLastCheckDate(DateTime from, DateTime to, boolean match) Matches the last checked date between the given times inclusive.
void	matchPackageId(Id packageId, boolean match) Sets the package Id for this query.
void	matchSiteId(Id siteId, boolean match) Sets the site Id for this query.
boolean	supportsAgentQuery() Tests if an AgentQuery is available for querying agents.
boolean	supportsPackageQuery() Tests if a PackageQuery is available for querying agents.
boolean	supportsSiteQuery() Tests if a SiteQuery is available for querying sites.

Methods inherited from interface org.osid.OsidObjectQuery

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchSiteId

void matchSiteId(Id siteId,
               boolean match)

Sets the site Id for this query.

Parameters:

siteId - a site Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - siteId is null

Compliance:

mandatory - This method must be implemented.

clearSiteIdTerms

void clearSiteIdTerms()

Clears the site Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSiteQuery

boolean supportsSiteQuery()

Tests if a SiteQuery is available for querying sites.

Returns:

true if a site query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSiteQuery

SiteQuery getSiteQuery()

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

Returns:

the site query

Throws:

UnimplementedException - supportsSiteQuery() is false

Compliance:

optional - This method must be implemented if supportsSiteQuery() is true.

clearSiteTerms

void clearSiteTerms()

Clears the site query terms.

Compliance:

mandatory - This method must be implemented.

matchPackageId

void matchPackageId(Id packageId,
                  boolean match)

Sets the package Id for this query.

Parameters:

packageId - a package Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - packageId is null

Compliance:

mandatory - This method must be implemented.

clearPackageIdTerms

void clearPackageIdTerms()

Clears the package Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsPackageQuery

boolean supportsPackageQuery()

Tests if a PackageQuery is available for querying agents.

Returns:

true if a package query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPackageQuery

PackageQuery getPackageQuery()

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

Returns:

the package query

Throws:

UnimplementedException - supportsPackageQuery() is false

Compliance:

optional - This method must be implemented if supportsPackageQuery() is true.

clearPackageTerms

void clearPackageTerms()

Clears the package query terms.

Compliance:

mandatory - This method must be implemented.

matchInstallDate

void matchInstallDate(DateTime from,
                    DateTime to,
                    boolean match)

Matches the install date between the given times inclusive.

Parameters:

from - starting range

to - ending range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - to is less than from

Compliance:

mandatory - This method must be implemented.

clearInstallDateTerms

void clearInstallDateTerms()

Clears the install date query terms.

Compliance:

mandatory - This method must be implemented.

matchAgentId

void matchAgentId(Id agentId,
                boolean match)

Sets the agent Id for this query.

Parameters:

agentId - an agent Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearAgentIdTerms

void clearAgentIdTerms()

Clears the agent Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAgentQuery

boolean supportsAgentQuery()

Tests if an AgentQuery is available for querying agents.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAgentQuery

AgentQuery getAgentQuery()

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

Returns:

the agent query

Throws:

UnimplementedException - supportsAgentQuery() is false

Compliance:

optional - This method must be implemented if supportsAgentQuery() is true.

clearAgentTerms

void clearAgentTerms()

Clears the agent query terms.

Compliance:

mandatory - This method must be implemented.

matchLastCheckDate

void matchLastCheckDate(DateTime from,
                      DateTime to,
                      boolean match)

Matches the last checked date between the given times inclusive.

Parameters:

from - starting range

to - ending range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - to is less than from

Compliance:

mandatory - This method must be implemented.

clearLastCheckDateTerms

void clearLastCheckDateTerms()

Clears the last check date query terms.

Compliance:

mandatory - This method must be implemented.

getInstallationQueryRecord

InstallationQueryRecord getInstallationQueryRecord(Type installationRecordType)
                                                   throws OperationFailedException

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

Parameters:

installationRecordType - an installation query record type

Returns:

the installation query record

Throws:

NullArgumentException - installationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(installationRecordType) is false

Compliance:

mandatory - This method must be implemented.