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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

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 {@code supportsSiteQuery()} is {@code 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 {@code supportsPackageQuery()} is {@code 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 {@code supportsAgentQuery()} is {@code 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.