org.osid.process

Interface ProcessQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface ProcessQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining process queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorProcessIdTerms() Gets the ancestor process Id terms.
ProcessQueryInspector[]	getAncestorProcessTerms() Gets the ancestor process terms.
IdTerm[]	getDescendantProcessIdTerms() Gets the descendant process Id terms.
ProcessQueryInspector[]	getDescendantProcessTerms() Gets the descendant process terms.
ProcessQueryInspectorRecord	getProcessQueryInspectorRecord(Type processRecordType) Gets the process query inspector record corresponding to the given Process record Type.
IdTerm[]	getStateIdTerms() Gets the state Id terms.
StateQueryInspector[]	getStateTerms() Gets the state terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, 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.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getStateIdTerms

IdTerm[] getStateIdTerms()

Gets the state Id terms.

Specified by:

getStateIdTerms in interface OsidObjectQueryInspector

Returns:

the state Id terms

Compliance:

mandatory - This method must be implemented.

getStateTerms

StateQueryInspector[] getStateTerms()

Gets the state terms.

Specified by:

getStateTerms in interface OsidObjectQueryInspector

Returns:

the state terms

Compliance:

mandatory - This method must be implemented.

getAncestorProcessIdTerms

IdTerm[] getAncestorProcessIdTerms()

Gets the ancestor process Id terms.

Returns:

the ancestor process Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorProcessTerms

ProcessQueryInspector[] getAncestorProcessTerms()

Gets the ancestor process terms.

Returns:

the ancestor process terms

Compliance:

mandatory - This method must be implemented.

getDescendantProcessIdTerms

IdTerm[] getDescendantProcessIdTerms()

Gets the descendant process Id terms.

Returns:

the descendant process Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantProcessTerms

ProcessQueryInspector[] getDescendantProcessTerms()

Gets the descendant process terms.

Returns:

the descendant process terms

Compliance:

mandatory - This method must be implemented.

getProcessQueryInspectorRecord

ProcessQueryInspectorRecord getProcessQueryInspectorRecord(Type processRecordType)
                                                           throws OperationFailedException

Gets the process query inspector record corresponding to the given Process record Type.

Parameters:

processRecordType - a process record type

Returns:

the process query inspector record

Throws:

NullArgumentException - processRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processRecordType) is false

Compliance:

mandatory - This method must be implemented.