OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.EffortQuery
Implementsosid.OsidRelationshipQuery
Description

This is the query for searching efforts. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchResourceId
Description

Sets the resource Id for this query.

Parametersosid.id.IdresourceIdthe resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearResourceIdTerms
Description

Clears the resource Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsResourceQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResourceQuery
Description

Gets the query for a resource. Multiple retrievals produce a nested OR term.

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsResourceQuery() is false
ComplianceoptionalThis method must be implemented if supportsResourceQuery() is true.
MethodclearResourceTerms
Description

Clears the resource query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCommissionId
Description

Sets the commission Id for this query.

Parametersosid.id.IdcommissionIdthe commission Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT commissionId is null
CompliancemandatoryThis method must be implemented.
MethodclearCommissionIdTerms
Description

Clears the commission Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCommissionQuery
Description

Tests if a CommissionQuery is available.

Returnboolean true if a commission query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCommissionQuery
Description

Gets the query for a commission. Multiple retrievals produce a nested OR term.

Returnosid.resourcing.CommissionQuerythe commission query
ErrorsUNIMPLEMENTED supportsCommissionQuery() is false
ComplianceoptionalThis method must be implemented if supportsCommissionQuery() is true.
MethodclearCommissionTerms
Description

Clears the commission query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimeSpent
Description

Matches the time spent between the given durations inclusive.

Parametersosid.calendaring.Durationstartstart range
osid.calendaring.Durationendend range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodclearTimeSpentTerms
Description

Clears the time spent query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFoundryId
Description

Sets the foundry Id for this query to match efforts assigned to foundries.

Parametersosid.id.IdfoundryIdthe foundry Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT foundryId is null
CompliancemandatoryThis method must be implemented.
MethodclearFoundryIdTerms
Description

Clears the foundry Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsFoundryQuery
Description

Tests if a FoundryQuery is available.

Returnboolean true if a foundry query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFoundryQuery
Description

Gets the query for a foundry. Multiple retrievals produce a nested OR term.

Returnosid.resourcing.FoundryQuerythe foundry query
ErrorsUNIMPLEMENTED supportsFoundryQuery() is false
ComplianceoptionalThis method must be implemented if supportsFoundryQuery() is true.
MethodclearFoundryTerms
Description

Clears the foundry query terms.

CompliancemandatoryThis method must be implemented.
MethodgetEffortQueryRecord
Description

Gets the effort query record corresponding to the given Effort record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeeffortRecordTypean effort record type
Returnosid.resourcing.records.EffortQueryRecordthe effort query record
ErrorsNULL_ARGUMENT effortRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(effortRecordType) is false
CompliancemandatoryThis method must be implemented.