org.osid.process

Interface StateQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface StateQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining state queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getProcessIdTerms() Gets the process Id terms.
ProcessQueryInspector[]	getProcessTerms() Gets the process terms.
StateQueryInspectorRecord	getStateQueryInspectorRecord(Type stateRecordType) Gets the state query inspector record corresponding to the given State record Type.

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

Method Detail

getProcessIdTerms

IdTerm[] getProcessIdTerms()

Gets the process Id terms.

Returns:

the process Id terms

Compliance:

mandatory - This method must be implemented.

getProcessTerms

ProcessQueryInspector[] getProcessTerms()

Gets the process terms.

Returns:

the process terms

Compliance:

mandatory - This method must be implemented.

getStateQueryInspectorRecord

StateQueryInspectorRecord getStateQueryInspectorRecord(Type stateRecordType)
                                                       throws OperationFailedException

Gets the state query inspector record corresponding to the given State record Type.

Parameters:

stateRecordType - a state record type

Returns:

the state query inspector record

Throws:

NullArgumentException - stateRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stateRecordType) is false

Compliance:

mandatory - This method must be implemented.