OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.IssueQuery
Implementsosid.OsidObjectQuery
Description

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

MethodmatchBureauId
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.
MethodclearBureauIdTerms
Description

Clears the resource Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBureauQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBureauQuery
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.
MethodclearBureauTerms
Description

Clears the resource query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBlockId
Description

Sets the block Id for this query.

Parametersosid.id.IdblockIdthe block Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT blockId is null
CompliancemandatoryThis method must be implemented.
MethodclearBlockIdTerms
Description

Clears the block Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBlockQuery
Description

Tests if a BlockQuery is available.

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

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

Returnosid.hold.BlockQuerythe block query
ErrorsUNIMPLEMENTED supportsBlockQuery() is false
ComplianceoptionalThis method must be implemented if supportsBlockQuery() is true.
MethodmatchAnyBlock
Description

Matches issues used for any block.

Parametersbooleanmatch true to match issues with any blocks, false to match issues with no blocks
CompliancemandatoryThis method must be implemented.
MethodclearBlockTerms
Description

Clears the block query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchHoldId
Description

Sets the hold Id for this query.

Parametersosid.id.IdholdIdthe hold Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT holdId is null
CompliancemandatoryThis method must be implemented.
MethodclearHoldIdTerms
Description

Clears the hold Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsHoldQuery
Description

Tests if a HoldQuery is available.

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

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

Returnosid.hold.HoldQuerythe hold query
ErrorsUNIMPLEMENTED supportsHoldQuery() is false
ComplianceoptionalThis method must be implemented if supportsHoldQuery() is true.
MethodmatchAnyHold
Description

Matches issues referenced by any hold.

Parametersbooleanmatch true to match issues with any holds, false to match issues with no holds
CompliancemandatoryThis method must be implemented.
MethodclearHoldTerms
Description

Clears the hold query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOublietteId
Description

Sets the oubliette Id for this query to match issues assigned to foundries.

Parametersosid.id.IdoublietteIdthe oubliette Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT oublietteId is null
CompliancemandatoryThis method must be implemented.
MethodclearOublietteIdTerms
Description

Clears the oubliette Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsOublietteQuery
Description

Tests if a OublietteQuery is available.

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

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

Returnosid.hold.OublietteQuerythe oubliette query
ErrorsUNIMPLEMENTED supportsOublietteQuery() is false
ComplianceoptionalThis method must be implemented if supportsOublietteQuery() is true.
MethodclearOublietteTerms
Description

Clears the oubliette query terms.

CompliancemandatoryThis method must be implemented.
MethodgetIssueQueryRecord
Description

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

Parametersosid.type.TypeissueRecordTypean issue record type
Returnosid.hold.records.IssueQueryRecordthe issue query record
ErrorsNULL_ARGUMENT issueRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(issueRecordType) is false
CompliancemandatoryThis method must be implemented.