OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.OublietteQuery
Implementsosid.OsidCatalogQuery
Description

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

MethodmatchBlockId
Description

Sets the effort Id for this query to match oubliettes containing blocks.

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 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 oubliettes that have any block.

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

Clears the block query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchIssueId
Description

Sets the issue Id for this query to match oubliettes that have a related issue.

Parametersosid.id.IdissueIda issue Id
booleanmatch true if a positive match, false for negative match
ErrorsNULL_ARGUMENT issueId is null
CompliancemandatoryThis method must be implemented.
MethodclearIssueIdTerms
Description

Clears the issue Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsIssueQuery
Description

Tests if a IssueQuery is available.

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

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

Returnosid.hold.IssueQuerythe issue query
ErrorsUNIMPLEMENTED supportsIssueQuery() is false
ComplianceoptionalThis method must be implemented if supportsIssueQuery() is true.
MethodmatchAnyIssue
Description

Matches oubliettes that have any issue.

Parametersbooleanmatch true to match oubliettes with any issue, false to match oubliettes with no issue
CompliancemandatoryThis method must be implemented.
MethodclearIssueTerms
Description

Clears the issue 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 oubliettes referenced by any hold.

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

Clears the hold query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorOublietteId
Description

Sets the oubliette Id for this query to match oubliettes that have the specified oubliette as an ancestor.

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

Clears the ancestor oubliette Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorOublietteQuery
Description

Tests if an OublietteQuery is available.

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

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

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

Matches oubliettes with any ancestor.

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

Clears the ancestor oubliette query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantOublietteId
Description

Sets the oubliette Id for this query to match oubliettes that have the specified oubliette as a descendant.

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

Clears the descendant oubliette Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantOublietteQuery
Description

Tests if an OublietteQuery is available.

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

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

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

Matches oubliettes with any descendant.

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

Clears the descendant oubliette query terms.

CompliancemandatoryThis method must be implemented.
MethodgetOublietteQueryRecord
Description

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

Parametersosid.type.TypeoublietteRecordTypean oubliette record type
Returnosid.hold.records.OublietteQueryRecordthe oubliette query record
ErrorsNULL_ARGUMENT oublietteRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(oublietteRecordType) is false
CompliancemandatoryThis method must be implemented.