OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.FoundryQuery
Implementsosid.OsidCatalogQuery
Description

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

MethodmatchJobId
Description

Sets the effort Id for this query to match foundries containing jobs.

Parametersosid.id.IdjobIdthe job Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT jobId is null
CompliancemandatoryThis method must be implemented.
MethodclearJobIdTerms
Description

Clears the job query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsJobQuery
Description

Tests if a JobQuery is available.

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

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

Returnosid.resourcing.JobQuerythe job query
ErrorsUNIMPLEMENTED supportsJobQuery() is false
ComplianceoptionalThis method must be implemented if supportsJobQuery() is true.
MethodmatchAnyJob
Description

Matches foundries that have any job.

Parametersbooleanmatch true to match foundries with any job, false to match foundries with no job
CompliancemandatoryThis method must be implemented.
MethodclearJobTerms
Description

Clears the job query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWorkId
Description

Sets the work Id for this query.

Parametersosid.id.IdworkIdthe work Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT workId is null
CompliancemandatoryThis method must be implemented.
MethodclearWorkIdTerms
Description

Clears the work Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsWorkQuery
Description

Tests if a WorkQuery is available.

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

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

Returnosid.resourcing.WorkQuerythe work query
ErrorsUNIMPLEMENTED supportsWorkQuery() is false
ComplianceoptionalThis method must be implemented if supportsWorkQuery() is true.
MethodmatchAnyWork
Description

Matches foundries that have any work.

Parametersbooleanmatch true to match foundries with any work, false to match foundries with no job
CompliancemandatoryThis method must be implemented.
MethodclearWorkTerms
Description

Clears the work query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAvailabilityId
Description

Sets the availability Id for this query to match foundries that have a related availability.

Parametersosid.id.IdavailabilityIda availability Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT availabilityId is null
CompliancemandatoryThis method must be implemented.
MethodclearAvailabilityIdTerms
Description

Clears the availability Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAvailabilityQuery
Description

Tests if a AvailabilityQuery is available.

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

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

Returnosid.resourcing.AvailabilityQuerythe availability query
ErrorsUNIMPLEMENTED supportsAvailabilityQuery() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityQuery() is true.
MethodmatchAnyAvailability
Description

Matches foundries that have any availability.

Parametersbooleanmatch true to match foundries with any availability, false to match foundries with no availability
CompliancemandatoryThis method must be implemented.
MethodclearAvailabilityTerms
Description

Clears the availability 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.
MethodmatchAnyCommission
Description

Matches foundries that have any commission.

Parametersbooleanmatch true to match foundries with any commission, false to match foundries with no commission
CompliancemandatoryThis method must be implemented.
MethodclearCommissionTerms
Description

Clears the commission query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEffortId
Description

Sets the effort Id for this query.

Parametersosid.id.IdeffortIdthe effort Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT effortId is null
CompliancemandatoryThis method must be implemented.
MethodclearEffortIdTerms
Description

Clears the effort Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEffortQuery
Description

Tests if an EffortQuery is available.

Returnboolean true if an effort query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEffortQuery
Description

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

Returnosid.resourcing.EffortQuerythe effort query
ErrorsUNIMPLEMENTED supportsEffortQuery() is false
ComplianceoptionalThis method must be implemented if supportsEffortQuery() is true.
MethodmatchAnyEffort
Description

Matches foundries with any effort.

Parametersbooleanmatch true to match foundries with any effort, false to match foundries with no effort
CompliancemandatoryThis method must be implemented.
MethodclearEffortTerms
Description

Clears the effort query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorFoundryId
Description

Sets the foundry Id for this query to match foundries that have the specified foundry as an ancestor.

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

Clears the ancestor foundry Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorFoundryQuery
Description

Tests if a FoundryQuery is available.

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

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

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

Matches foundries with any ancestor.

Parametersbooleanmatch true to match foundries with any ancestor, false to match root foundries
CompliancemandatoryThis method must be implemented.
MethodclearAncestorFoundryTerms
Description

Clears the ancestor foundry query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantFoundryId
Description

Sets the foundry Id for this query to match foundries that have the specified foundry as a descendant.

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

Clears the descendant foundry Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantFoundryQuery
Description

Tests if a FoundryQuery is available.

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

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

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

Matches foundries with any descendant.

Parametersbooleanmatch true to match foundries with any descendant, false to match leaf foundries
CompliancemandatoryThis method must be implemented.
MethodclearDescendantFoundryTerms
Description

Clears the descendant foundry query terms.

CompliancemandatoryThis method must be implemented.
MethodgetFoundryQueryRecord
Description

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

Parametersosid.type.TypefoundryRecordTypea foundry record type
Returnosid.resourcing.records.FoundryQueryRecordthe foundry query record
ErrorsNULL_ARGUMENT foundryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(foundryRecordType) is false
CompliancemandatoryThis method must be implemented.