org.osid.workflow.rules

Interface ProcessEnablerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector

public interface ProcessEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query interface for examining process enabler 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.
ProcessEnablerQueryInspectorRecord	getProcessEnablerQueryInspectorRecord(Type processEnablerRecordType) Gets the process enabler query inspector record corresponding to the given ProcessEnabler record Type.
IdTerm[]	getRuledProcessIdTerms() Gets the process Id query terms.
ProcessQueryInspector[]	getRuledProcessTerms() Gets the process query terms.

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

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

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRuledProcessIdTerms

IdTerm[] getRuledProcessIdTerms()

Gets the process Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledProcessTerms

ProcessQueryInspector[] getRuledProcessTerms()

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

getProcessEnablerQueryInspectorRecord

ProcessEnablerQueryInspectorRecord getProcessEnablerQueryInspectorRecord(Type processEnablerRecordType)
                                                                         throws OperationFailedException

Gets the process enabler query inspector record corresponding to the given ProcessEnabler record Type.

Parameters:

processEnablerRecordType - a process enabler record type

Returns:

the process enabler query inspector record

Throws:

NullArgumentException - processEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.