org.osid.workflow.rules

Interface StepProcessorQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidProcessorQueryInspector, OsidQueryInspector, OsidRuleQueryInspector

public interface StepProcessorQueryInspector
extends OsidProcessorQueryInspector

This is the query inspector for examining step processor queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getOfficeIdTerms() Gets the office Id query terms.
OfficeQueryInspector[]	getOfficeTerms() Gets the office query terms.
IdTerm[]	getRuledStepIdTerms() Gets the step Id query terms.
StepQueryInspector[]	getRuledStepTerms() Gets the step query terms.
StepProcessorQueryInspectorRecord	getStepProcessorQueryInspectorRecord(Type stepProcessorRecordType) Gets the step processor query inspector record corresponding to the given StepProcessor record Type.

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

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

Method Detail

getRuledStepIdTerms

IdTerm[] getRuledStepIdTerms()

Gets the step Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledStepTerms

StepQueryInspector[] getRuledStepTerms()

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

getStepProcessorQueryInspectorRecord

StepProcessorQueryInspectorRecord getStepProcessorQueryInspectorRecord(Type stepProcessorRecordType)
                                                                       throws OperationFailedException

Gets the step processor query inspector record corresponding to the given StepProcessor record Type.

Parameters:

stepProcessorRecordType - a step processor record type

Returns:

the step processor query inspector record

Throws:

NullArgumentException - stepProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.