org.osid.workflow

Interface OfficeQueryInspector

All Superinterfaces:

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

public interface OfficeQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining office queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorOfficeIdTerms() Gets the ancestor office Id query terms.
OfficeQueryInspector[]	getAncestorOfficeTerms() Gets the ancestor office query terms.
IdTerm[]	getDescendantOfficeIdTerms() Gets the descendant office Id query terms.
OfficeQueryInspector[]	getDescendantOfficeTerms() Gets the descendant office query terms.
OfficeQueryInspectorRecord	getOfficeQueryInspectorRecord(Type officeRecordType) Gets the office query inspector record corresponding to the given Office record Type.
IdTerm[]	getProcessIdTerms() Gets the process Id query terms.
ProcessQueryInspector[]	getProcessTerms() Gets the process query terms.
IdTerm[]	getStepIdTerms() Gets the step Id query terms.
StepQueryInspector[]	getStepTerms() Gets the step query terms.
IdTerm[]	getWorkIdTerms() Gets the work Id query terms.
WorkQueryInspector[]	getWorkTerms() Gets the work 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

getProcessIdTerms

IdTerm[] getProcessIdTerms()

Gets the process Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProcessTerms

ProcessQueryInspector[] getProcessTerms()

Gets the process query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStepIdTerms

IdTerm[] getStepIdTerms()

Gets the step Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStepTerms

StepQueryInspector[] getStepTerms()

Gets the step query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getWorkIdTerms

IdTerm[] getWorkIdTerms()

Gets the work Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getWorkTerms

WorkQueryInspector[] getWorkTerms()

Gets the work query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorOfficeIdTerms

IdTerm[] getAncestorOfficeIdTerms()

Gets the ancestor office Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorOfficeTerms

OfficeQueryInspector[] getAncestorOfficeTerms()

Gets the ancestor office query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantOfficeIdTerms

IdTerm[] getDescendantOfficeIdTerms()

Gets the descendant office Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantOfficeTerms

OfficeQueryInspector[] getDescendantOfficeTerms()

Gets the descendant office query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOfficeQueryInspectorRecord

OfficeQueryInspectorRecord getOfficeQueryInspectorRecord(Type officeRecordType)
                                                         throws OperationFailedException

Gets the office query inspector record corresponding to the given Office record Type.

Parameters:

officeRecordType - a office record type

Returns:

the office query inspector record

Throws:

NullArgumentException - officeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(officeRecordType) is false

Compliance:

mandatory - This method must be implemented.