org.ametys.plugins.survey.repository

Class Survey

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<F>

org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject<F>

org.ametys.plugins.survey.repository.AbstractSurveyElement<SurveyFactory>

org.ametys.plugins.survey.repository.Survey

All Implemented Interfaces:

ACLAmetysObject, AmetysObject, CopiableAmetysObject, JCRAmetysObject, JCRTraversableAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TraversableAmetysObject, SiteAwareAmetysObject

public class Survey
extends AbstractSurveyElement<SurveyFactory>
implements SiteAwareAmetysObject

AmetysObject representing a survey

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__PROPERTY_DESC Constants for description metadata.
private static String	__PROPERTY_END_DATE Constants for end date metadata.
private static String	__PROPERTY_ENDING_MSG Constants for description metadata.
private static String	__PROPERTY_LABEL Constants for header metadata.
private static String	__PROPERTY_REDIRECTION Constants for private metadata.
private static String	__PROPERTY_START_DATE Constants for start date metadata.
private static String	__PROPERTY_TITLE Constants for title metadata.
private static String	__PROPERTY_VALIDATED Constants for private metadata.
private static String	__PROPERTY_VALIDATION_DATE Constants for private metadata.

Fields inherited from class org.ametys.plugins.survey.repository.AbstractSurveyElement

PROPERTY_PICTURE, PROPERTY_PICTURE_ALTERNATIVE, PROPERTY_PICTURE_ID, PROPERTY_PICTURE_TYPE

Constructor Summary

Constructors

Constructor and Description
Survey(Node node, String parentPath, SurveyFactory factory) Creates a Survey.

Method Summary

Modifier and Type	Method and Description
private boolean	_hasQuestionName(String name)
Survey	copyTo(ModifiableTraversableAmetysObject parent, String name) Copy the current AmetysObject to the given object.
Survey	copyTo(ModifiableTraversableAmetysObject parent, String name, List<String> restrictTo) Copy the current AmetysObject to the given object if it is not in the restriction list.
String	findUniqueQuestionName(String originalName) Returns a unique question name in the survey
String	getDescription() Retrieves the description.
Date	getEndDate() Get the end date
String	getEndingMessage() Retrieves the ending message.
String	getLabel() Retrieves the survey label.
String	getLanguage() Get the survey language.
List<SurveyPage>	getPages() Get the survey pages.
SurveyQuestion	getQuestion(String name) Get a question by its name.
AmetysObjectIterable<SurveyQuestion>	getQuestions() Get the survey questions.
String	getRedirection() Retrieves the redirection.
Site	getSite() Returns this object's site.
String	getSiteName() Returns this object's site name.
Date	getStartDate() Get the start date
String	getTitle() Retrieves the title.
Date	getValidationDate() Get the date of validation
boolean	isValidated() Determines if the survey is validated.
void	setDescription(String description) Set the description.
void	setEndDate(Date date) Set the end date
void	setEndingMessage(String message) Set the ending message.
void	setLabel(String label) Set the survey label.
void	setRedirection(String pageId) Set the redirection.
void	setStartDate(Date date) Set the start date
void	setTitle(String title) Set the title.
void	setValidated(boolean validated) Valid or invalid survey
void	setValidationDate(Date date) Set the date of validation

Methods inherited from class org.ametys.plugins.survey.repository.AbstractSurveyElement

copyPictureTo, getExternalPicture, getPictureAlternative, getPictureType, getResourcePictureId, removePictureMetas, setExternalPicture, setNoPicture, setPictureAlternative, setPictureType, setResourcePicture

Methods inherited from class org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, createChild, getAllowedGroups, getAllowedProfilesForAnonymous, getAllowedProfilesForAnyConnectedUser, getAllowedProfilesForGroups, getAllowedProfilesForUser, getAllowedProfilesForUsers, getAllowedUsers, getChild, getChildren, getDeniedGroups, getDeniedProfilesForAnonymous, getDeniedProfilesForAnyConnectedUser, getDeniedProfilesForGroups, getDeniedProfilesForUser, getDeniedProfilesForUsers, getDeniedUsers, hasChild, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getNode, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject

getNode

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject

remove

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject

getChildAt, getChildPosition

Field Detail

__PROPERTY_TITLE

private static final String __PROPERTY_TITLE

Constants for title metadata.

See Also:

Constant Field Values

__PROPERTY_LABEL

private static final String __PROPERTY_LABEL

Constants for header metadata.

See Also:

Constant Field Values

__PROPERTY_DESC

private static final String __PROPERTY_DESC

Constants for description metadata.

See Also:

Constant Field Values

__PROPERTY_ENDING_MSG

private static final String __PROPERTY_ENDING_MSG

Constants for description metadata.

See Also:

Constant Field Values

__PROPERTY_VALIDATED

private static final String __PROPERTY_VALIDATED

Constants for private metadata.

See Also:

Constant Field Values

__PROPERTY_VALIDATION_DATE

private static final String __PROPERTY_VALIDATION_DATE

Constants for private metadata.

See Also:

Constant Field Values

__PROPERTY_START_DATE

private static final String __PROPERTY_START_DATE

Constants for start date metadata.

See Also:

Constant Field Values

__PROPERTY_END_DATE

private static final String __PROPERTY_END_DATE

Constants for end date metadata.

See Also:

Constant Field Values

__PROPERTY_REDIRECTION

private static final String __PROPERTY_REDIRECTION

Constants for private metadata.

See Also:

Constant Field Values

Constructor Detail

Survey

public Survey(Node node,
              String parentPath,
              SurveyFactory factory)

Creates a Survey.

Parameters:

node - the node backing this AmetysObject.

parentPath - the parent path in the Ametys hierarchy.

factory - the SurveyFactory which creates the AmetysObject.

Method Detail

getTitle

public String getTitle()
                throws AmetysRepositoryException

Retrieves the title.

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

setTitle

public void setTitle(String title)
              throws AmetysRepositoryException

Set the title.

Parameters:

title - the title.

Throws:

AmetysRepositoryException - if an error occurs.

getLabel

public String getLabel()
                throws AmetysRepositoryException

Retrieves the survey label.

Returns:

the the survey label.

Throws:

AmetysRepositoryException - if an error occurs.

setLabel

public void setLabel(String label)
              throws AmetysRepositoryException

Set the survey label.

Parameters:

label - the survey label.

Throws:

AmetysRepositoryException - if an error occurs.

getDescription

public String getDescription()
                      throws AmetysRepositoryException

Retrieves the description.

Returns:

the description.

Throws:

AmetysRepositoryException - if an error occurs.

setDescription

public void setDescription(String description)
                    throws AmetysRepositoryException

Set the description.

Parameters:

description - the description.

Throws:

AmetysRepositoryException - if an error occurs.

getEndingMessage

public String getEndingMessage()
                        throws AmetysRepositoryException

Retrieves the ending message.

Returns:

the ending message.

Throws:

AmetysRepositoryException - if an error occurs.

setEndingMessage

public void setEndingMessage(String message)
                      throws AmetysRepositoryException

Set the ending message.

Parameters:

message - the ending message.

Throws:

AmetysRepositoryException - if an error occurs.

isValidated

public boolean isValidated()
                    throws AmetysRepositoryException

Determines if the survey is validated.

Returns:

true if the survey is validated.

Throws:

AmetysRepositoryException - if an error occurs.

setValidated

public void setValidated(boolean validated)
                  throws AmetysRepositoryException

Valid or invalid survey

Parameters:

validated - true to validate the survey

Throws:

AmetysRepositoryException - if an error occurs.

setValidationDate

public void setValidationDate(Date date)
                       throws AmetysRepositoryException

Set the date of validation

Parameters:

date - The date of validation

Throws:

AmetysRepositoryException - if an error occurs.

getValidationDate

public Date getValidationDate()
                       throws AmetysRepositoryException

Get the date of validation

Returns:

the date of validation

Throws:

AmetysRepositoryException - if an error occurs.

setStartDate

public void setStartDate(Date date)
                  throws AmetysRepositoryException

Set the start date

Parameters:

date - The start date

Throws:

AmetysRepositoryException - if an error occurs.

getStartDate

public Date getStartDate()
                  throws AmetysRepositoryException

Get the start date

Returns:

the start date

Throws:

AmetysRepositoryException - if an error occurs.

setEndDate

public void setEndDate(Date date)
                throws AmetysRepositoryException

Set the end date

Parameters:

date - The end date

Throws:

AmetysRepositoryException - if an error occurs.

getEndDate

public Date getEndDate()
                throws AmetysRepositoryException

Get the end date

Returns:

the end date

Throws:

AmetysRepositoryException - if an error occurs.

getRedirection

public String getRedirection()
                      throws AmetysRepositoryException

Retrieves the redirection.

Returns:

the page id of redirection or null.

Throws:

AmetysRepositoryException - if an error occurs.

setRedirection

public void setRedirection(String pageId)
                    throws AmetysRepositoryException

Set the redirection.

Parameters:

pageId - the page id. Can be null to delete redirection

Throws:

AmetysRepositoryException - if an error occurs.

getPages

public List<SurveyPage> getPages()
                          throws AmetysRepositoryException

Get the survey pages.

Returns:

the survey pages.

Throws:

AmetysRepositoryException - if an error occurs when retrieving the pages of the survey

getQuestion

public SurveyQuestion getQuestion(String name)
                           throws AmetysRepositoryException

Get a question by its name.

Parameters:

name - the question name.

Returns:

the question.

Throws:

AmetysRepositoryException - if an error occurs when retrieving a question of a survey

getQuestions

public AmetysObjectIterable<SurveyQuestion> getQuestions()
                                                  throws AmetysRepositoryException

Get the survey questions.

Returns:

the survey questions.

Throws:

AmetysRepositoryException - if an error occurs when retrieving all the questions of a survey

getSite

public Site getSite()
             throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site.

Specified by:

getSite in interface SiteAwareAmetysObject

Returns:

this object's site

Throws:

AmetysRepositoryException - if an error occurs.

getSiteName

public String getSiteName()
                   throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site name.

Specified by:

getSiteName in interface SiteAwareAmetysObject

Returns:

this object's site name.

Throws:

AmetysRepositoryException - if an error occurs.

getLanguage

public String getLanguage()

Get the survey language.

Returns:

the survey language.

findUniqueQuestionName

public String findUniqueQuestionName(String originalName)

Returns a unique question name in the survey

Parameters:

originalName - The original name

Returns:

a unique question name

_hasQuestionName

private boolean _hasQuestionName(String name)

copyTo

public Survey copyTo(ModifiableTraversableAmetysObject parent,
                     String name)
              throws AmetysRepositoryException

Description copied from interface: CopiableAmetysObject

Copy the current AmetysObject to the given object. Be careful, this method save changes.

Specified by:

copyTo in interface CopiableAmetysObject

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public Survey copyTo(ModifiableTraversableAmetysObject parent,
                     String name,
                     List<String> restrictTo)
              throws AmetysRepositoryException

Description copied from interface: CopiableAmetysObject

Copy the current AmetysObject to the given object if it is not in the restriction list. Be careful, this method save changes.

Specified by:

copyTo in interface CopiableAmetysObject

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

restrictTo - A restrict list of CopiableAmetysObject authorized to be copied

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.