OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.OsidRelationshipQuery
Implementsosid.OsidObjectQuery
osid.OsidTemporalQuery
Description

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

MethodmatchEndReasonId
Description

Match the Id of the end reason state.

Parametersosid.id.IdstateId Id to match
booleanmatch true if for a positive match, false for a negative match
ErrorsNULL_ARGUMENT ruleId is null
CompliancemandatoryThis method must be implemented.
MethodclearEndReasonIdTerms
Description

Clears all state Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEndReasonQuery
Description

Tests if a StateQuery for the end reason is available.

Returnboolean true if a end reason query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEndReasonQuery
Description

Gets the query for the end reason state. Each retrieval performs a boolean OR.

Parametersbooleanmatch true if for a positive match, false for a negative match
Returnosid.process.StateQuerythe state query
ErrorsUNIMPLEMENTED supportsEndReasonQuery() is false
ComplianceoptionalThis method must be implemented if supportsEndReasonQuery() is true.
MethodmatchAnyEndReason
Description

Match any end reason state.

Parametersbooleanmatch true to match any state, false to match no state
CompliancemandatoryThis method must be implemented.
MethodclearEndReasonTerms
Description

Clears all end reason state terms.

CompliancemandatoryThis method must be implemented.