org.osid.tracking

Interface FrontOfficeQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface FrontOfficeQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining front office queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorFrontOfficeIdTerms() Gets the ancestor front office Id query terms.
FrontOfficeQueryInspector[]	getAncestorFrontOfficeTerms() Gets the ancestor front office query terms.
IdTerm[]	getDescendantFrontOfficeIdTerms() Gets the descendant front office Id query terms.
FrontOfficeQueryInspector[]	getDescendantFrontOfficeTerms() Gets the descendant front office query terms.
FrontOfficeQueryInspectorRecord	getFrontOfficeQueryInspectorRecord(Type frontOfficeRecordType) Gets the front office query inspector record corresponding to the given FrontOffice record Type.
IdTerm[]	getIssueIdTerms() Gets the issue Id query terms.
IssueQueryInspector[]	getIssueTerms() Gets the issue query terms.
IdTerm[]	getQueueIdTerms() Gets the queue Id query terms.
QueueQueryInspector[]	getQueueTerms() Gets the queue query terms.

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

getQueueIdTerms

IdTerm[] getQueueIdTerms()

Gets the queue Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getQueueTerms

QueueQueryInspector[] getQueueTerms()

Gets the queue query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorFrontOfficeIdTerms

IdTerm[] getAncestorFrontOfficeIdTerms()

Gets the ancestor front office Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorFrontOfficeTerms

FrontOfficeQueryInspector[] getAncestorFrontOfficeTerms()

Gets the ancestor front office query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantFrontOfficeIdTerms

IdTerm[] getDescendantFrontOfficeIdTerms()

Gets the descendant front office Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantFrontOfficeTerms

FrontOfficeQueryInspector[] getDescendantFrontOfficeTerms()

Gets the descendant front office query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFrontOfficeQueryInspectorRecord

FrontOfficeQueryInspectorRecord getFrontOfficeQueryInspectorRecord(Type frontOfficeRecordType)
                                                                   throws OperationFailedException

Gets the front office query inspector record corresponding to the given FrontOffice record Type.

Parameters:

frontOfficeRecordType - a front office record type

Returns:

the front office query inspector record

Throws:

NullArgumentException - frontOfficeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(frontOfficeRecordType) is false

Compliance:

mandatory - This method must be implemented.