org.osid.resourcing

Interface EffortQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface EffortQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining effort queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCommissionIdTerms() Gets the commission Id query terms.
CommissionQueryInspector[]	getCommissionTerms() Gets the commission query terms.
EffortQueryInspectorRecord	getEffortQueryInspectorRecord(Type effortRecordType) Gets the effort query inspector record corresponding to the given Effort record Type.
IdTerm[]	getFoundryIdTerms() Gets the foundry Id query terms.
FoundryQueryInspector[]	getFoundryTerms() Gets the foundry query terms.
IdTerm[]	getResourceIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource query terms.
DurationRangeTerm[]	getTimeSpentTerms() Gets the time spent query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCommissionIdTerms

IdTerm[] getCommissionIdTerms()

Gets the commission Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCommissionTerms

CommissionQueryInspector[] getCommissionTerms()

Gets the commission query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTimeSpentTerms

DurationRangeTerm[] getTimeSpentTerms()

Gets the time spent query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFoundryIdTerms

IdTerm[] getFoundryIdTerms()

Gets the foundry Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFoundryTerms

FoundryQueryInspector[] getFoundryTerms()

Gets the foundry query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEffortQueryInspectorRecord

EffortQueryInspectorRecord getEffortQueryInspectorRecord(Type effortRecordType)
                                                         throws OperationFailedException

Gets the effort query inspector record corresponding to the given Effort record Type.

Parameters:

effortRecordType - an effort record type

Returns:

the effort query inspector record

Throws:

NullArgumentException - effortRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(effortRecordType) is false

Compliance:

mandatory - This method must be implemented.