org.osid.workflow

Interface ProcessQueryInspector

All Superinterfaces:

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

public interface ProcessQueryInspector
extends OsidGovernatorQueryInspector

This is the query inspector for examining process queries.

Method Summary

Methods

Modifier and Type	Method and Description
BooleanTerm[]	getEnabledTerms() Gets the enabled query terms.
IdTerm[]	getInitialStateIdTerms() Gets the initial state Id query terms.
StateQueryInspector[]	getInitialStateTerms() Gets the initial state query terms.
IdTerm[]	getInitialStepIdTerms() Gets the initial step Id query terms.
StepQueryInspector[]	getInitialStepTerms() Gets the initial step query terms.
IdTerm[]	getOfficeIdTerms() Gets the office Id query terms.
OfficeQueryInspector[]	getOfficeTerms() Gets the office query terms.
ProcessQueryInspectorRecord	getProcessQueryInspectorRecord(Type processRecordType) Gets the process query inspector record corresponding to the given Process record Type.
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.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getEnabledTerms

BooleanTerm[] getEnabledTerms()

Gets the enabled query terms.

Specified by:

getEnabledTerms in interface OsidOperableQueryInspector

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInitialStepIdTerms

IdTerm[] getInitialStepIdTerms()

Gets the initial step Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInitialStepTerms

StepQueryInspector[] getInitialStepTerms()

Gets the initial step query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInitialStateIdTerms

IdTerm[] getInitialStateIdTerms()

Gets the initial state Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInitialStateTerms

StateQueryInspector[] getInitialStateTerms()

Gets the initial state 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.

getOfficeIdTerms

IdTerm[] getOfficeIdTerms()

Gets the office Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOfficeTerms

OfficeQueryInspector[] getOfficeTerms()

Gets the office query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProcessQueryInspectorRecord

ProcessQueryInspectorRecord getProcessQueryInspectorRecord(Type processRecordType)
                                                           throws OperationFailedException

Gets the process query inspector record corresponding to the given Process record Type.

Parameters:

processRecordType - a process record type

Returns:

the process query inspector record

Throws:

NullArgumentException - processRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processRecordType) is false

Compliance:

mandatory - This method must be implemented.