org.osid.learning

Interface ProficiencyNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ProficiencyNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Proficiency objects in this ObjectiveBank. This also includes existing proficiencies that may appear or disappear due to changes in the ObjectiveBank hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the ProficiencyLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForProficiencyNotifications() Tests if this user can register for Proficiency notifications.
ObjectiveBank	getObjectiveBank() Gets the ObjectiveBank associated with this session.
Id	getObjectiveBankId() Gets the ObjectiveBank Id associated with this session.
void	registerForChangedProficiencies() Registers for notification of updated proficiencies.
void	registerForChangedProficienciesByGenusType(Type proficiencyGenusType) Registers for notification of updated proficiencies of the given genus type.
void	registerForChangedProficienciesForObjective(Id objectiveId) Registers for notification of an updated proficiency.
void	registerForChangedProficienciesForResource(Id resourceId) Registers for notification of an updated proficiency.
void	registerForChangedProficiency(Id proficiencyId) Registers for notification of an updated proficiency.
void	registerForDeletedProficiencies() Registers for notification of deleted proficiencies.
void	registerForDeletedProficienciesByGenusType(Type proficiencyGenusType) Registers for notification of deleted proficiencies of the given genus type.
void	registerForDeletedProficienciesForObjective(Id objectiveId) Registers for notification of a deleted proficiency.
void	registerForDeletedProficienciesForResource(Id resourceId) Registers for notification of a deleted proficiency.
void	registerForDeletedProficiency(Id proficiencyId) Registers for notification of a deleted proficiency.
void	registerForNewProficiencies() Register for notifications of new proficiencies.
void	registerForNewProficienciesByGenusType(Type proficiencyGenusType) Register for notifications of new proficiencies with the given genus type.
void	registerForNewProficienciesForObjective(Id objectiveId) Register for notifications of new proficiencies.
void	registerForNewProficienciesForResource(Id resourceId) Register for notifications of new proficiencies.
void	useFederatedObjectiveBankView() Federates the view for methods in this session.
void	useIsolatedObjectiveBankView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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 obective bank

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForProficiencyNotifications

boolean canRegisterForProficiencyNotifications()

Tests if this user can register for Proficiency notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 notification operations.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedObjectiveBankView

void useFederatedObjectiveBankView()

Federates the view for methods in this session. A federated view will include proficiencies in objective banks which are children of this objective bank in the obective bank hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedObjectiveBankView

void useIsolatedObjectiveBankView()

Isolates the view for methods in this session. An isolated view restricts notifications to this objective bank only.

Compliance:

mandatory - This method is must be implemented.

registerForNewProficiencies

void registerForNewProficiencies()
                                 throws OperationFailedException,
                                        PermissionDeniedException

Register for notifications of new proficiencies. ProficiencyReceiver.newProficiency() is invoked when a new Proficiency appears in this objective bank.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewProficienciesByGenusType

void registerForNewProficienciesByGenusType(Type proficiencyGenusType)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Register for notifications of new proficiencies with the given genus type. ProficiencyReceiver.newProficiency() is invoked when a new Proficiency appears for the given resource in this objective bank.

Parameters:

proficiencyGenusType - the genus type of a proficiency to monitor

Throws:

NullArgumentException - proficiencyGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewProficienciesForObjective

void registerForNewProficienciesForObjective(Id objectiveId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Register for notifications of new proficiencies. ProficiencyReceiver.newProficiency() is invoked when a new Proficiency appears for the given objective in this objective bank.

Parameters:

objectiveId - the Id of a resource to monitor

Throws:

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewProficienciesForResource

void registerForNewProficienciesForResource(Id resourceId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Register for notifications of new proficiencies. ProficiencyReceiver.newProficiency() is invoked when a new Proficiency appears for the given resource in this objective bank.

Parameters:

resourceId - the Id of a resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedProficiencies

void registerForChangedProficiencies()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification of updated proficiencies. ProficiencyReceiver.changedProficiency() is invoked when a proficiency in this objective bank is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedProficienciesByGenusType

void registerForChangedProficienciesByGenusType(Type proficiencyGenusType)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Registers for notification of updated proficiencies of the given genus type. ProficiencyReceiver.changedProficiency() is invoked when a proficiency in this objective bank is changed.

Parameters:

proficiencyGenusType - the genus type of the Proficiency to monitor

Throws:

NullArgumentException - proficiencyGenusTYpe is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedProficienciesForObjective

void registerForChangedProficienciesForObjective(Id objectiveId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Registers for notification of an updated proficiency. ProficiencyReceiver.changedProficiency() is invoked when the specified proficiency related to the given objective is changed in this objective bank.

Parameters:

objectiveId - the Id of the Objective to monitor

Throws:

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedProficienciesForResource

void registerForChangedProficienciesForResource(Id resourceId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Registers for notification of an updated proficiency. ProficiencyReceiver.changedProficiency() is invoked when the specified proficiency related to the given resource is changed in this objective bank.

Parameters:

resourceId - the Id of the Resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedProficiency

void registerForChangedProficiency(Id proficiencyId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of an updated proficiency. ProficiencyReceiver.changedProficiency() is invoked when the specified proficiency in this objective bank is changed.

Parameters:

proficiencyId - the Id of the Proficiency to monitor

Throws:

NullArgumentException - proficiencyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedProficiencies

void registerForDeletedProficiencies()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification of deleted proficiencies. ProficiencyReceiver.deletedProficiency() is invoked when a proficiency is deleted or removed from this objective bank.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedProficienciesByGenusType

void registerForDeletedProficienciesByGenusType(Type proficiencyGenusType)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Registers for notification of deleted proficiencies of the given genus type. ProficiencyReceiver.deletedProficiency() is invoked when a proficiency is deleted or removed from this objective bank.

Parameters:

proficiencyGenusType - the genus type of the Proficiency to monitor

Throws:

NullArgumentException - proficiencyGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedProficienciesForObjective

void registerForDeletedProficienciesForObjective(Id objectiveId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Registers for notification of a deleted proficiency. ProficiencyReceiver.deletedProficiency() is invoked when the specified proficiency related to the objective is deleted or removed from this objective bank.

Parameters:

objectiveId - the Id of the Objective to monitor

Throws:

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedProficienciesForResource

void registerForDeletedProficienciesForResource(Id resourceId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Registers for notification of a deleted proficiency. ProficiencyReceiver.deletedProficiency() is invoked when the specified proficiency related to the resource is deleted or removed from this objective bank.

Parameters:

resourceId - the Id of the Resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedProficiency

void registerForDeletedProficiency(Id proficiencyId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of a deleted proficiency. ProficiencyReceiver.deletedProficiency() is invoked when the specified proficiency is deleted or removed from this objective bank.

Parameters:

proficiencyId - the Id of the Proficiency to monitor

Throws:

NullArgumentException - proficiencyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.