Package org.ametys.plugins.forms.helper

Class ScheduleOpeningHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.helper.ScheduleOpeningHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ScheduleOpeningHelper
extends AbstractLogEnabled
implements Serviceable, Component

The helper to schedule opening of form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ScheduleOpeningHelper.FormStatus	The form status

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected FormDAO	_formDAO	The form DAO
protected FormMailHelper	_formMailHelper	The form mail helper
protected AmetysObjectResolver	_resolver	Ametys object resolver.
protected UserManager	_userManager	The users manager
static final String	ROLE	Avalon ROLE.

Constructor Summary

Constructors

Constructor	Description
ScheduleOpeningHelper()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getScheduledDates(String formId)	Get the scheduled dates of a form
ScheduleOpeningHelper.FormStatus	getStatus(Form form)	Get the opening status of the form
void	service(ServiceManager manager)
boolean	setScheduledDate(String formId, String startDateAsStr, String endDateAsStr)	Set date of publication of form

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

Field Details

ROLE

public static final String ROLE

Avalon ROLE.

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver.

_userManager

protected UserManager _userManager

The users manager

_formMailHelper

protected FormMailHelper _formMailHelper

The form mail helper

_formDAO

protected FormDAO _formDAO

The form DAO

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Details

ScheduleOpeningHelper

public ScheduleOpeningHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getScheduledDates

public Map<String,Object> getScheduledDates(String formId)

Get the scheduled dates of a form

Parameters:

formId - the id of the form

Returns:

a map with start date and end date

setScheduledDate

public boolean setScheduledDate(String formId,
 String startDateAsStr,
 String endDateAsStr)

Set date of publication of form

Parameters:

formId - The form id

startDateAsStr - The start date. Can be null.

endDateAsStr - The end date. Can be null.

Returns:

true if operation has succeeded.

getStatus

public ScheduleOpeningHelper.FormStatus getStatus(Form form)

Get the opening status of the form

Parameters:

form - the form

Returns:

'open', 'over', or 'coming' depending on today's date