OSID Logo
OSID Specifications
relationship rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.rules.RelationshipEnablerQuery
Implementsosid.OsidEnablerQuery
Description

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

MethodmatchRuledRelationshipId
Description

Matches enablers mapped to the relationship.

Parametersosid.id.IdrelationshipIdthe relationship Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT relationshipId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledRelationshipIdTerms
Description

Clears the relationship Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledRelationshipQuery
Description

Tests if a RelationshipQuery is available.

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

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

Returnosid.relationship.RelationshipQuerythe relationship query
ErrorsUNIMPLEMENTED supportsRuledRelationshipQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledRelationshipQuery() is true.
MethodmatchAnyRuledRelationship
Description

Matches enablers mapped to any relationship.

Parametersbooleanmatch true for enablers mapped to any relationship, false to match enablers mapped to no relationship
CompliancemandatoryThis method must be implemented.
MethodclearRuledRelationshipTerms
Description

Clears the relationship query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFamilyId
Description

Matches enablers mapped to a family.

Parametersosid.id.IdfamilyIdthe family Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT familyId is null
CompliancemandatoryThis method must be implemented.
MethodclearFamilyIdTerms
Description

Clears the family Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsFamilyQuery
Description

Tests if a FamilyQuery is available.

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

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

Returnosid.relationship.FamilyQuerythe family query
ErrorsUNIMPLEMENTED supportsFamilyQuery() is false
ComplianceoptionalThis method must be implemented if supportsFamilyQuery() is true.
MethodclearFamilyTerms
Description

Clears the family query terms.

CompliancemandatoryThis method must be implemented.
MethodgetRelationshipEnablerQueryRecord
Description

Gets the relationship enabler query record corresponding to the given RelationshipEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TyperelationshipEnablerRecordTypea relationship enabler record type
Returnosid.relationship.rules.records.RelationshipEnablerQueryRecordthe relationship enabler query record
ErrorsNULL_ARGUMENT relationshipEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(relationshipEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.