org.osid.workflow

Interface StepQueryInspector

All Superinterfaces:

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

public interface StepQueryInspector
extends OsidGovernatorQueryInspector, OsidSubjugateableQueryInspector

This is the query inspector for examining step queries.

Method Summary

Methods

Modifier and Type	Method and Description
BooleanTerm[]	getInitialTerms() Gets the initial step query terms.
IdTerm[]	getInputStateIdTerms() Gets the input state Id query terms.
StateQueryInspector[]	getInputStateTerms() Gets the input state query terms.
IdTerm[]	getNextStateIdTerms() Gets the next state Id query terms.
StateQueryInspector[]	getNextStateTerms() Gets the next state query terms.
IdTerm[]	getOfficeIdTerms() Gets the office Id query terms.
OfficeQueryInspector[]	getOfficeTerms() Gets the office query terms.
IdTerm[]	getProcessIdTerms() Gets the process Id query terms.
ProcessQueryInspector[]	getProcessTerms() Gets the process query terms.
IdTerm[]	getResourceIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource query terms.
StepQueryInspectorRecord	getStepQueryInspectorRecord(Type stepRecordType) Gets the step query inspector record corresponding to the given Step record Type.
BooleanTerm[]	getTerminalTerms() Gets the terminal 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, getEnabledTerms, getOperationalTerms

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.

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource 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.

getInitialTerms

BooleanTerm[] getInitialTerms()

Gets the initial step query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTerminalTerms

BooleanTerm[] getTerminalTerms()

Gets the terminal step query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInputStateIdTerms

IdTerm[] getInputStateIdTerms()

Gets the input state Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInputStateTerms

StateQueryInspector[] getInputStateTerms()

Gets the input state query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getNextStateIdTerms

IdTerm[] getNextStateIdTerms()

Gets the next state Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getNextStateTerms

StateQueryInspector[] getNextStateTerms()

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

getStepQueryInspectorRecord

StepQueryInspectorRecord getStepQueryInspectorRecord(Type stepRecordType)
                                                     throws OperationFailedException

Gets the step query inspector record corresponding to the given Step record Type.

Parameters:

stepRecordType - a step record type

Returns:

the step query inspector record

Throws:

NullArgumentException - stepRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepRecordType) is false

Compliance:

mandatory - This method must be implemented.