OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.HoldQuery
Implementsosid.OsidRelationshipQuery
Description

This is the query for searching holds. 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.
MethodmatchAnyResource
Description

Matches holds that have any resource defined.

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

Clears the resource query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAgentId
Description

Sets the agent Id for this query.

Parametersosid.id.IdagentIdthe agent Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodclearAgentIdTerms
Description

Clears the agent Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAgentQuery
Description

Tests if an AgentQuery is available.

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

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

Returnosid.authentication.AgentQuerythe agent query
ErrorsUNIMPLEMENTED supportsAgentQuery() is false
ComplianceoptionalThis method must be implemented if supportsAgentQuery() is true.
MethodmatchAnyAgent
Description

Matches holds that have any agent defined.

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

Clears the agent query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchIssueId
Description

Sets the issue Id for this query.

Parametersosid.id.IdissueIdthe issue Id
booleanmatch true for a positive match, false for a 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 an IssueQuery is available.

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

Gets the query for an 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.
MethodclearIssueTerms
Description

Clears the issue query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOublietteId
Description

Sets the oubliette Id for this query to match holds 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.
MethodgetHoldQueryRecord
Description

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

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