org.osid.workflow.rules

Interface StepConstrainerQueryInspector

All Superinterfaces:

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

public interface StepConstrainerQueryInspector
extends OsidConstrainerQueryInspector

This is the query inspector for examining step constrainer 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.
StepConstrainerQueryInspectorRecord	getStepConstrainerQueryInspectorRecord(Type stepConstrainerRecordType) Gets the step constrainer query inspector record corresponding to the given StepConstrainer 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.

getStepConstrainerQueryInspectorRecord

StepConstrainerQueryInspectorRecord getStepConstrainerQueryInspectorRecord(Type stepConstrainerRecordType)
                                                                           throws OperationFailedException

Gets the step constrainer query inspector record corresponding to the given StepConstrainer record Type.

Parameters:

stepConstrainerRecordType - a step constrainer record type

Returns:

the step constrainer query inspector record

Throws:

NullArgumentException - stepConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.