org.osid.tracking

Interface QueueQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidGovernatorQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface QueueQueryInspector
extends OsidGovernatorQueryInspector

This is the query inspector for examining queue queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getFrontOfficeIdTerms() Gets the front office Id query terms.
FrontOfficeQueryInspector[]	getFrontOfficeTerms() Gets the front office query terms.
IdTerm[]	getIssueIdTerms() Gets the issue Id query terms.
IssueQueryInspector[]	getIssueTerms() Gets the issue query terms.
QueueQueryInspectorRecord	getQueueQueryInspectorRecord(Type queueRecordType) Gets the queue query inspector record corresponding to the given Queue record Type.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getIssueIdTerms

IdTerm[] getIssueIdTerms()

Gets the issue Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIssueTerms

IssueQueryInspector[] getIssueTerms()

Gets the issue query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFrontOfficeIdTerms

IdTerm[] getFrontOfficeIdTerms()

Gets the front office Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFrontOfficeTerms

FrontOfficeQueryInspector[] getFrontOfficeTerms()

Gets the front office query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getQueueQueryInspectorRecord

QueueQueryInspectorRecord getQueueQueryInspectorRecord(Type queueRecordType)
                                                       throws OperationFailedException

Gets the queue query inspector record corresponding to the given Queue record Type.

Parameters:

queueRecordType - a queue record type

Returns:

the queue query inspector record

Throws:

NullArgumentException - queueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueRecordType) is false

Compliance:

mandatory - This method must be implemented.