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, Prioritizable, Supporter<Event>, 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()	Get the priority for the component.
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
void	service(ServiceManager manager)
boolean	supports(Event event)	Check if an element 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

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

getTraits

Constructor Details

ShareableFieldCourseObserver

public ShareableFieldCourseObserver()

Method Details

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: Supporter

Check if an element is supported

Specified by:

supports in interface Supporter<Event>

Parameters:

event - The element

Returns:

true if the element is supported, false otherwise

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the 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