org.osid.tracking

Interface QueueQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface QueueQuery
extends OsidGovernatorQuery

This is the query for searching queues. 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	clearFrontOfficeIdTerms() Clears the front office Id query terms.
void	clearFrontOfficeTerms() Clears the front office query terms.
void	clearIssueIdTerms() Clears the issue Id query terms.
void	clearIssueTerms() Clears the issue query terms.
FrontOfficeQuery	getFrontOfficeQuery() Gets the query for a front office.
IssueQuery	getIssueQuery() Gets the query for a issue.
QueueQueryRecord	getQueueQueryRecord(Type queueRecordType) Gets the queue query record corresponding to the given Queue record Type.
void	matchAnyIssue(boolean match) Matches log entries that go through any issue.
void	matchFrontOfficeId(Id frontOfficeId, boolean match) Sets the front office Id for this query to match queues assigned to front offices.
void	matchIssueId(Id issueId, boolean match) Sets the issue Id for this query to match queues that pass through issues.
boolean	supportsFrontOfficeQuery() Tests if a FrontOfficeQuery is available.
boolean	supportsIssueQuery() Tests if a IssueQuery 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.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

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 queues that pass through issues.

Parameters:

issueId - the issue Id

match - true for 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 log entries that go through any issue.

Parameters:

match - true to match log entries with any issue, false to match log entries 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.

matchFrontOfficeId

void matchFrontOfficeId(Id frontOfficeId,
                      boolean match)

Sets the front office Id for this query to match queues assigned to front offices.

Parameters:

frontOfficeId - the 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.

clearFrontOfficeIdTerms

void clearFrontOfficeIdTerms()

Clears the front office Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsFrontOfficeQuery

boolean supportsFrontOfficeQuery()

Tests if a FrontOfficeQuery is available.

Returns:

true if a front office query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFrontOfficeQuery

FrontOfficeQuery getFrontOfficeQuery()

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

Returns:

the front office query

Throws:

UnimplementedException - supportsFrontOfficeQuery() is false

Compliance:

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

clearFrontOfficeTerms

void clearFrontOfficeTerms()

Clears the front office query terms.

Compliance:

mandatory - This method must be implemented.

getQueueQueryRecord

QueueQueryRecord getQueueQueryRecord(Type queueRecordType)
                                     throws OperationFailedException

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

Parameters:

queueRecordType - a queue record type

Returns:

the queue query record

Throws:

NullArgumentException - queueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueRecordType) is false

Compliance:

mandatory - This method must be implemented.