Package org.ametys.odf.observation

Class ShareableFieldCourseObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.observation.ShareableFieldCourseObserver

All Implemented Interfaces:

Observer, LogEnabled, Serviceable

public class ShareableFieldCourseObserver
extends AbstractLogEnabled
implements Observer, Serviceable

Observer to unlink the shareable field of a Course on Content deletion.

Field Summary

Fields inherited from interface org.ametys.core.observation.Observer

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
ShareableFieldCourseObserver()

Method Summary

Modifier and Type	Method	Description
protected void	_editShareableField(AmetysObjectIterable<Course> courses, String contentId, String attributeNameToRemove)	Edit shareable fields
int	getPriority(Event event)	Retrieves the priority to observe this event. This can be used to process a supported event before others observers.
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
void	service(ServiceManager manager)
boolean	supports(Event event)	Checks if the event is supported.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShareableFieldCourseObserver

public ShareableFieldCourseObserver()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

supports

public boolean supports(Event event)

Description copied from interface: Observer

Checks if the event is supported. If true, the observe(Event) method will be called.

Specified by:

supports in interface Observer

Parameters:

event - the event.

Returns:

true for observing this event, false otherwise.

getPriority

public int getPriority(Event event)

Description copied from interface: Observer

Retrieves the priority to observe this event.
This can be used to process a supported event before others observers.

Specified by:

getPriority in interface Observer

Parameters:

event - the event.

Returns:

the priority where 0 the max priority and Integer.MAX_VALUE the min priority.

observe

public void observe(Event event,
                    Map<String,Object> transientVars)
             throws Exception

Description copied from interface: Observer

Observes an event.

Specified by:

observe in interface Observer

Parameters:

event - the event.

transientVars - transientVars passed from one Observer to another when processing a single Event. This may allow optimizations between observers.

Throws:

Exception - if an error occurs. All exceptions will be logged but not propagated, as the observation mechanism should never fail.

_editShareableField

protected void _editShareableField(AmetysObjectIterable<Course> courses,
                                   String contentId,
                                   String attributeNameToRemove)
                            throws com.opensymphony.workflow.WorkflowException

Edit shareable fields

Parameters:

courses - the list of courses to edit shareable fields

contentId - the content id to remove from sharebale fields

attributeNameToRemove - the attribute name of the shareable field

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurred