Interface FrontOfficeQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface FrontOfficeQuery
extends OsidCatalogQuery

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

Method Summary

Modifier and Type	Method	Description
void	clearAncestorFrontOfficeIdTerms()	Clears the ancestor front office Id query terms.
void	clearAncestorFrontOfficeTerms()	Clears the ancestor front office query terms.
void	clearDescendantFrontOfficeIdTerms()	Clears the descendant front office Id query terms.
void	clearDescendantFrontOfficeTerms()	Clears the descendant front office query terms.
void	clearIssueIdTerms()	Clears the issue Id query terms.
void	clearIssueTerms()	Clears the issue query terms.
void	clearQueueIdTerms()	Clears the queue query terms.
void	clearQueueTerms()	Clears the queue query terms.
FrontOfficeQuery	getAncestorFrontOfficeQuery()	Gets the query for a frontOffice/ Multiple retrievals produce a nested OR term.
FrontOfficeQuery	getDescendantFrontOfficeQuery()	Gets the query for a frontOffice/ Multiple retrievals produce a nested OR term.
FrontOfficeQueryRecord	getFrontOfficeQueryRecord(Type frontOfficeRecordType)	Gets the front office query record corresponding to the given FrontOffice record Type .
IssueQuery	getIssueQuery()	Gets the query for a issue.
QueueQuery	getQueueQuery()	Gets the query for a queue.
void	matchAncestorFrontOfficeId(Id frontOfficeId, boolean match)	Sets the front office Id for this query to match front offices that have the specified front office as an ancestor.
void	matchAnyAncestorFrontOffice(boolean match)	Matches front offices with any ancestor.
void	matchAnyDescendantFrontOffice(boolean match)	Matches front offices with any descendant.
void	matchAnyIssue(boolean match)	Matches front offices that have any issue.
void	matchAnyQueue(boolean match)	Matches front offices that have any queue.
void	matchDescendantFrontOfficeId(Id frontOfficeId, boolean match)	Sets the front office Id for this query to match front offices that have the specified front office as a descendant.
void	matchIssueId(Id issueId, boolean match)	Sets the issue Id for this query to match front offices that have a related issue.
void	matchQueueId(Id queueId, boolean match)	Sets the effort Id for this query to match front offices containing queues.
boolean	supportsAncestorFrontOfficeQuery()	Tests if a FrontOfficeQuery is available.
boolean	supportsDescendantFrontOfficeQuery()	Tests if a FrontOfficeQuery is available.
boolean	supportsIssueQuery()	Tests if a IssueQuery is available.
boolean	supportsQueueQuery()	Tests if a QueueQuery is available.

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.

Methods inherited from interface OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

matchIssueId

void matchIssueId(Id issueId,
 boolean match)

Sets the issue Id for this query to match front offices that have a related issue.

Parameters:

issueId - a issue Id

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

Throws:

NullArgumentException - issueId is null

Compliance:

mandatory - This method must be implemented.

clearIssueIdTerms

void clearIssueIdTerms()

Clears the issue Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsIssueQuery

boolean supportsIssueQuery()

Tests if a IssueQuery is available.

Returns:

true if a issue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getIssueQuery

IssueQuery getIssueQuery()

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

Returns:

the issue query

Throws:

UnimplementedException - supportsIssueQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsIssueQuery()} is {@code true} .

matchAnyIssue

void matchAnyIssue(boolean match)

Matches front offices that have any issue.

Parameters:

match - true to match front offices with any issue, false to match front offices with no issue

Compliance:

mandatory - This method must be implemented.

clearIssueTerms

void clearIssueTerms()

Clears the issue query terms.

Compliance:

mandatory - This method must be implemented.

matchQueueId

void matchQueueId(Id queueId,
 boolean match)

Sets the effort Id for this query to match front offices containing queues.

Parameters:

queueId - the queue Id

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

Throws:

NullArgumentException - queueId is null

Compliance:

mandatory - This method must be implemented.

clearQueueIdTerms

void clearQueueIdTerms()

Clears the queue query terms.

Compliance:

mandatory - This method must be implemented.

supportsQueueQuery

boolean supportsQueueQuery()

Tests if a QueueQuery is available.

Returns:

true if a queue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getQueueQuery

QueueQuery getQueueQuery()

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

Returns:

the queue query

Throws:

UnimplementedException - supportsQueueQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueQuery()} is {@code true} .

matchAnyQueue

void matchAnyQueue(boolean match)

Matches front offices that have any queue.

Parameters:

match - true to match front offices with any queue, false to match front offices with no queue

Compliance:

mandatory - This method must be implemented.

clearQueueTerms

void clearQueueTerms()

Clears the queue query terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorFrontOfficeId

void matchAncestorFrontOfficeId(Id frontOfficeId,
 boolean match)

Sets the front office Id for this query to match front offices that have the specified front office as an ancestor.

Parameters:

frontOfficeId - a front office Id

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

Throws:

NullArgumentException - frontOfficeId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorFrontOfficeIdTerms

void clearAncestorFrontOfficeIdTerms()

Clears the ancestor front office Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorFrontOfficeQuery

boolean supportsAncestorFrontOfficeQuery()

Tests if a FrontOfficeQuery is available.

Returns:

true if a front office query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorFrontOfficeQuery

FrontOfficeQuery getAncestorFrontOfficeQuery()

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

Returns:

the front office query

Throws:

UnimplementedException - supportsAncestorFrontOfficeQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAncestorFrontOfficeQuery()} is {@code true} .

matchAnyAncestorFrontOffice

void matchAnyAncestorFrontOffice(boolean match)

Matches front offices with any ancestor.

Parameters:

match - true to match front offices with any ancestor, false to match root frontOffices

Compliance:

mandatory - This method must be implemented.

clearAncestorFrontOfficeTerms

void clearAncestorFrontOfficeTerms()

Clears the ancestor front office query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantFrontOfficeId

void matchDescendantFrontOfficeId(Id frontOfficeId,
 boolean match)

Sets the front office Id for this query to match front offices that have the specified front office as a descendant.

Parameters:

frontOfficeId - a front office Id

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

Throws:

NullArgumentException - frontOfficeId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantFrontOfficeIdTerms

void clearDescendantFrontOfficeIdTerms()

Clears the descendant front office Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantFrontOfficeQuery

boolean supportsDescendantFrontOfficeQuery()

Tests if a FrontOfficeQuery is available.

Returns:

true if a front office query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantFrontOfficeQuery

FrontOfficeQuery getDescendantFrontOfficeQuery()

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

Returns:

the front office query

Throws:

UnimplementedException - supportsDescendantFrontOfficeQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDescendantFrontOfficeQuery()} is {@code true} .

matchAnyDescendantFrontOffice

void matchAnyDescendantFrontOffice(boolean match)

Matches front offices with any descendant.

Parameters:

match - true to match front offices with any descendant, false to match leaf frontOffices

Compliance:

mandatory - This method must be implemented.

clearDescendantFrontOfficeTerms

void clearDescendantFrontOfficeTerms()

Clears the descendant front office query terms.

Compliance:

mandatory - This method must be implemented.

getFrontOfficeQueryRecord

FrontOfficeQueryRecord getFrontOfficeQueryRecord(Type frontOfficeRecordType)
                                          throws OperationFailedException

Gets the front office query record corresponding to the given FrontOffice record Type . Multiple record retrievals produce a nested OR term.

Parameters:

frontOfficeRecordType - a front office record type

Returns:

the front office query record

Throws:

NullArgumentException - frontOfficeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(frontOfficeRecordType) is false

Compliance:

mandatory - This method must be implemented.