OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ObjectiveBankQuery
Implementsosid.OsidCatalogQuery
Description

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

MethodmatchObjectiveId
Description

Sets the objective Id for this query.

Parametersosid.id.IdobjectiveIdan objective Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectiveId is null
CompliancemandatoryThis method must be implemented.
MethodclearObjectiveIdTerms
Description

Clears the objective Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsObjectiveQuery
Description

Tests if an ObjectiveQuery is available.

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

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

Returnosid.learning.ObjectiveQuerythe objective query
ErrorsUNIMPLEMENTED supportsObjectiveQuery() is false
ComplianceoptionalThis method must be implemented if supportsObjectiveQuery() is true.
MethodmatchAnyObjective
Description

Matches an objective bank that has any objective assigned.

Parametersbooleanmatch true to match objective banks with any objective, false to match objective banks with no objectives
CompliancemandatoryThis method must be implemented.
MethodclearObjectiveTerms
Description

Clears the objective terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActivityId
Description

Sets the activity Id for this query.

Parametersosid.id.IdactivityIdan activity Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT activityId is null
CompliancemandatoryThis method must be implemented.
MethodclearActivityIdTerms
Description

Clears the activity Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsActivityQuery
Description

Tests if a ActivityQuery is available for querying activities.

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

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

Returnosid.learning.ActivityQuerythe activity query
ErrorsUNIMPLEMENTED supportsActivityQuery() is false
ComplianceoptionalThis method must be implemented if supportsActivityQuery() is true.
MethodmatchAnyActivity
Description

Matches an objective bank that has any activity assigned.

Parametersbooleanmatch true to match objective banks with any activity, false to match objective banks with no activities
CompliancemandatoryThis method must be implemented.
MethodclearActivityTerms
Description

Clears the activity terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorObjectiveBankId
Description

Sets the objective bank Id for this query to match objective banks that have the specified objective bank as an ancestor.

Parametersosid.id.IdobjectiveBankIdan objective bank Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectiveBankId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorObjectiveBankIdTerms
Description

Clears the ancestor objective bank Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorObjectiveBankQuery
Description

Tests if a ObjectiveBankQuery is available for querying ancestor objective banks.

Returnboolean true if an objective bank query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorObjectiveBankQuery
Description

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

Returnosid.learning.ObjectiveBankQuerythe objective bank query
ErrorsUNIMPLEMENTED supportsAncestorObjectiveBankQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorCalndarQuery() is true.
MethodmatchAnyAncestorObjectiveBank
Description

Matches an objective bank that has any ancestor.

Parametersbooleanmatch true to match objective banks with any ancestor, false to match root objective banks
CompliancemandatoryThis method must be implemented.
MethodclearAncestorObjectiveBankTerms
Description

Clears the ancestor objective bank terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantObjectiveBankId
Description

Sets the objective bank Id for this query to match objective banks that have the specified objective bank as a descendant.

Parametersosid.id.IdobjectiveBankIdan objective bank Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectiveBankId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantObjectiveBankIdTerms
Description

Clears the descendant objective bank Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantObjectiveBankQuery
Description

Tests if a ObjectiveBankQuery is available for querying descendant objective banks.

Returnboolean true if an objective bank query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantObjectiveBankQuery
Description

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

Returnosid.learning.ObjectiveBankQuerythe objective bank query
ErrorsUNIMPLEMENTED supportsDescendantObjectiveBankQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantCalndarQuery() is true.
MethodmatchAnyDescendantObjectiveBank
Description

Matches an objective bank that has any descendant.

Parametersbooleanmatch true to match objective banks with any descendant, false to match leaf objective banks
CompliancemandatoryThis method must be implemented.
MethodclearDescendantObjectiveBankTerms
Description

Clears the descendant objective bank terms.

CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBankQueryRecord
Description

Gets the objective bank query record corresponding to the given ObjectiveBank record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeobjectiveBankRecordTypean objective bank record type
Returnosid.learning.records.ObjectiveBankQueryRecordthe objective bank query record
ErrorsNULL_ARGUMENT objectiveBankRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(objectiveBankRecordType) is false
CompliancemandatoryThis method must be implemented.