org.osid.workflow

Interface WorkQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface WorkQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining work 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[]	getProcessIdTerms() Gets the process Id query terms.
ProcessQueryInspector[]	getProcessTerms() Gets the process query terms.
IdTerm[]	getStepIdTerms() Gets the step Id query terms.
StepQueryInspector[]	getStepTerms() Gets the step query terms.
BooleanTerm[]	getSuspendedTerms() Gets the suspended query terms.
WorkQueryInspectorRecord	getWorkQueryInspectorRecord(Type workRecordType) Gets the work query inspector record corresponding to the given Work 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

getSuspendedTerms

BooleanTerm[] getSuspendedTerms()

Gets the suspended query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProcessIdTerms

IdTerm[] getProcessIdTerms()

Gets the process Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProcessTerms

ProcessQueryInspector[] getProcessTerms()

Gets the process query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStepIdTerms

IdTerm[] getStepIdTerms()

Gets the step Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStepTerms

StepQueryInspector[] getStepTerms()

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.

getWorkQueryInspectorRecord

WorkQueryInspectorRecord getWorkQueryInspectorRecord(Type workRecordType)
                                                     throws OperationFailedException

Gets the work query inspector record corresponding to the given Work record Type.

Parameters:

workRecordType - a work record type

Returns:

the work query inspector record

Throws:

NullArgumentException - workRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(workRecordType) is false

Compliance:

mandatory - This method must be implemented.