org.osid.tracking

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

Methods

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

Methods inherited from interface org.osid.OsidSourceableQuery

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

Method Detail

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 supportsIssueQuery() is 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 supportsQueueQuery() is 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 supportsAncestorFrontOfficeQuery() is 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 supportsDescendantFrontOfficeQuery() is 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.