Interface ObjectiveRequisiteAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ObjectiveRequisiteAssignmentSession
extends OsidSession

This session provides methods to manage requisites.

Method Summary

Modifier and Type	Method	Description
void	assignEquivalentObjective(Id objectiveId, Id equivalentObjectiveId)	Makes an objective equivalent to another objective for the purposes of satisfying a requisite.
void	assignObjectiveRequisite(Id objectiveId, Id requisiteObjectiveId)	Creates a requirement dependency between two Objectives .
boolean	canAssignRequisites()	Tests if this user can manage objective requisites.
ObjectiveBank	getObjectiveBank()	Gets the ObjectiveBank associated with this session.
Id	getObjectiveBankId()	Gets the ObjectiveBank Id associated with this session.
void	unassignEquivalentObjective(Id objectiveId, Id equivalentObjectiveId)	Removes an Objective requisite from an Objective .
void	unassignObjectiveRequisite(Id objectiveId, Id requisiteObjectiveId)	Removes an Objective requisite from an Objective .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getObjectiveBankId

Id getObjectiveBankId()

Gets the ObjectiveBank Id associated with this session.

Returns:

the ObjectiveBank Id associated with this session

Compliance:

mandatory - This method must be implemented.

getObjectiveBank

ObjectiveBank getObjectiveBank()
                        throws OperationFailedException,
PermissionDeniedException

Gets the ObjectiveBank associated with this session.

Returns:

the ObjectiveBank associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignRequisites

boolean canAssignRequisites()

Tests if this user can manage objective requisites. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignObjectiveRequisite

void assignObjectiveRequisite(Id objectiveId,
 Id requisiteObjectiveId)
                       throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Creates a requirement dependency between two Objectives .

Parameters:

objectiveId - the Id of the dependent Objective

requisiteObjectiveId - the Id of the required Objective

Throws:

AlreadyExistsException - objectiveId already mapped to requisiteObjectiveId

NotFoundException - objectiveId or requisiteObjectiveId not found

NullArgumentException - objectiveId or requisiteObjectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignObjectiveRequisite

void unassignObjectiveRequisite(Id objectiveId,
 Id requisiteObjectiveId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an Objective requisite from an Objective .

Parameters:

objectiveId - the Id of the Objective

requisiteObjectiveId - the Id of the required Objective

Throws:

NotFoundException - objectiveId or requisiteObjectiveId not found or objectiveId not mapped to requisiteObjectiveId

NullArgumentException - objectiveId or requisiteObjectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

assignEquivalentObjective

void assignEquivalentObjective(Id objectiveId,
 Id equivalentObjectiveId)
                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Makes an objective equivalent to another objective for the purposes of satisfying a requisite.

Parameters:

objectiveId - the Id of the principal Objective

equivalentObjectiveId - the Id of the equivalent Objective

Throws:

AlreadyExistsException - objectiveId already mapped to equiavelntObjectiveId

NotFoundException - objectiveId or equivalentObjectiveId not found

NullArgumentException - objectiveId or equivalentObjectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignEquivalentObjective

void unassignEquivalentObjective(Id objectiveId,
 Id equivalentObjectiveId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an Objective requisite from an Objective .

Parameters:

objectiveId - the Id of the principal Objective

equivalentObjectiveId - the Id of the equivalent Objective

Throws:

NotFoundException - objectiveId or equivalentObjectiveId not found or objectiveId is already equivalent to equivalentObjectiveId

NullArgumentException - objectiveId or equivalentObjectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.