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<SurveyFactory>

org.ametys.plugins.survey.repository.Survey

All Implemented Interfaces:

org.ametys.plugins.repository.AmetysObject, org.ametys.plugins.repository.CopiableAmetysObject, org.ametys.plugins.repository.jcr.JCRAmetysObject, org.ametys.plugins.repository.jcr.JCRTraversableAmetysObject, org.ametys.plugins.repository.metadata.MetadataAwareAmetysObject, org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject, org.ametys.plugins.repository.ModifiableAmetysObject, org.ametys.plugins.repository.ModifiableTraversableAmetysObject, org.ametys.plugins.repository.RemovableAmetysObject, org.ametys.plugins.repository.TraversableAmetysObject, org.ametys.web.repository.SiteAwareAmetysObject

public class Survey
extends org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject<SurveyFactory>
implements org.ametys.web.repository.SiteAwareAmetysObject, org.ametys.plugins.repository.CopiableAmetysObject

AmetysObject for storing survey

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Survey	copyTo(org.ametys.plugins.repository.ModifiableTraversableAmetysObject parent, java.lang.String name)
Survey	copyTo(org.ametys.plugins.repository.ModifiableTraversableAmetysObject parent, java.lang.String name, java.util.List<java.lang.String> restrictTo)
java.lang.String	findUniqueQuestionName(java.lang.String originalName) Returns a unique question name in the survey
java.lang.String	getDescription() Retrieves the description.
java.util.Date	getEndDate() Get the end date
java.lang.String	getEndingMessage() Retrieves the ending message.
org.ametys.plugins.repository.metadata.BinaryMetadata	getExternalPicture() Get the picture as a binary metadata.
java.util.Set<java.lang.String>	getGrantedGroups() Get the granted users.
java.util.Set<java.lang.String>	getGrantedUsers() Get the granted users.
java.lang.String	getLabel() Retrieves the survey label.
java.lang.String	getLanguage() Get the survey language.
org.ametys.plugins.repository.AmetysObjectIterable<SurveyPage>	getPages() Get the survey pages.
java.lang.String	getPictureAlternative() Get the picture alternative.
java.lang.String	getPictureType() Get the picture type.
SurveyQuestion	getQuestion(java.lang.String name) Get a question by its name.
org.ametys.plugins.repository.AmetysObjectIterable<SurveyQuestion>	getQuestions() Get the survey questions.
java.lang.String	getRedirection() Retrieves the redirection.
java.lang.String	getResourcePictureId() Get the picture resource ID.
org.ametys.web.repository.site.Site	getSite()
java.lang.String	getSiteName()
java.util.Date	getStartDate() Get the start date
java.lang.String	getTitle() Retrieves the title.
java.util.Date	getValidationDate() Get the date of validation
boolean	isPrivate() Determines if the survey is private.
boolean	isValidated() Determines if the survey is validated.
protected void	removePictureMetas() Remove all picture metas (picture ID and picture binary).
void	setDescription(java.lang.String description) Set the description.
void	setEndDate(java.util.Date date) Set the end date
void	setEndingMessage(java.lang.String message) Set the ending message.
void	setExternalPicture(java.lang.String mimeType, java.lang.String filename, java.io.InputStream stream) Set the picture from an external file.
void	setGrantedGroups(java.util.Collection<java.lang.String> groups) Set the granted users.
void	setGrantedUsers(java.util.Collection<java.lang.String> users) Set the granted users.
void	setLabel(java.lang.String label) Set the survey label.
void	setNoPicture() Removes any picture currently assigned.
void	setPictureAlternative(java.lang.String alternative) Set the picture alternative.
void	setPictureType(java.lang.String type) Set the picture type.
void	setPrivate(boolean isPrivate) Set the privacy.
void	setRedirection(java.lang.String pageId) Set the redirection.
void	setResourcePicture(java.lang.String resourceId) Set the picture from an explorer resource.
void	setStartDate(java.util.Date date) Set the start date
void	setTitle(java.lang.String title) Set the title.
void	setValidated(boolean validated) Valid or invalid survey
void	setValidationDate(java.util.Date date) Set the date of validation

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

createChild, getChild, getChildren, hasChild

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

Constructor Detail

Survey

public Survey(javax.jcr.Node node,
              java.lang.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 java.lang.String getTitle()
                          throws org.ametys.plugins.repository.AmetysRepositoryException

Retrieves the title.

Returns:

the title.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setTitle

public void setTitle(java.lang.String title)
              throws org.ametys.plugins.repository.AmetysRepositoryException

Set the title.

Parameters:

title - the title.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getLabel

public java.lang.String getLabel()
                          throws org.ametys.plugins.repository.AmetysRepositoryException

Retrieves the survey label.

Returns:

the the survey label.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setLabel

public void setLabel(java.lang.String label)
              throws org.ametys.plugins.repository.AmetysRepositoryException

Set the survey label.

Parameters:

label - the survey label.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getDescription

public java.lang.String getDescription()
                                throws org.ametys.plugins.repository.AmetysRepositoryException

Retrieves the description.

Returns:

the description.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setDescription

public void setDescription(java.lang.String description)
                    throws org.ametys.plugins.repository.AmetysRepositoryException

Set the description.

Parameters:

description - the description.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getEndingMessage

public java.lang.String getEndingMessage()
                                  throws org.ametys.plugins.repository.AmetysRepositoryException

Retrieves the ending message.

Returns:

the ending message.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setEndingMessage

public void setEndingMessage(java.lang.String message)
                      throws org.ametys.plugins.repository.AmetysRepositoryException

Set the ending message.

Parameters:

message - the ending message.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

isPrivate

public boolean isPrivate()
                  throws org.ametys.plugins.repository.AmetysRepositoryException

Determines if the survey is private.

Returns:

true if the survey is private.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setPrivate

public void setPrivate(boolean isPrivate)
                throws org.ametys.plugins.repository.AmetysRepositoryException

Set the privacy.

Parameters:

isPrivate - the privacy

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

isValidated

public boolean isValidated()
                    throws org.ametys.plugins.repository.AmetysRepositoryException

Determines if the survey is validated.

Returns:

true if the survey is validated.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setValidated

public void setValidated(boolean validated)
                  throws org.ametys.plugins.repository.AmetysRepositoryException

Valid or invalid survey

Parameters:

validated - true to validate the survey

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setValidationDate

public void setValidationDate(java.util.Date date)
                       throws org.ametys.plugins.repository.AmetysRepositoryException

Set the date of validation

Parameters:

date - The date of validation

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getValidationDate

public java.util.Date getValidationDate()
                                 throws org.ametys.plugins.repository.AmetysRepositoryException

Get the date of validation

Returns:

the date of validation

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setStartDate

public void setStartDate(java.util.Date date)
                  throws org.ametys.plugins.repository.AmetysRepositoryException

Set the start date

Parameters:

date - The start date

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getStartDate

public java.util.Date getStartDate()
                            throws org.ametys.plugins.repository.AmetysRepositoryException

Get the start date

Returns:

the start date

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setEndDate

public void setEndDate(java.util.Date date)
                throws org.ametys.plugins.repository.AmetysRepositoryException

Set the end date

Parameters:

date - The end date

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getEndDate

public java.util.Date getEndDate()
                          throws org.ametys.plugins.repository.AmetysRepositoryException

Get the end date

Returns:

the end date

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getRedirection

public java.lang.String getRedirection()
                                throws org.ametys.plugins.repository.AmetysRepositoryException

Retrieves the redirection.

Returns:

the page id of redirection or null.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setRedirection

public void setRedirection(java.lang.String pageId)
                    throws org.ametys.plugins.repository.AmetysRepositoryException

Set the redirection.

Parameters:

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

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getGrantedUsers

public java.util.Set<java.lang.String> getGrantedUsers()
                                                throws org.ametys.plugins.repository.AmetysRepositoryException

Get the granted users.

Returns:

the set of logins of the granted users.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setGrantedUsers

public void setGrantedUsers(java.util.Collection<java.lang.String> users)
                     throws org.ametys.plugins.repository.AmetysRepositoryException

Set the granted users.

Parameters:

users - a collection of logins of the granted users to set.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getGrantedGroups

public java.util.Set<java.lang.String> getGrantedGroups()
                                                 throws org.ametys.plugins.repository.AmetysRepositoryException

Get the granted users.

Returns:

the set of logins of the granted users.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setGrantedGroups

public void setGrantedGroups(java.util.Collection<java.lang.String> groups)
                      throws org.ametys.plugins.repository.AmetysRepositoryException

Set the granted users.

Parameters:

groups - a collection of ids of the granted groups to set.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getPages

public org.ametys.plugins.repository.AmetysObjectIterable<SurveyPage> getPages()
                                                                        throws org.ametys.plugins.repository.AmetysRepositoryException

Get the survey pages.

Returns:

the survey pages.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException

getQuestion

public SurveyQuestion getQuestion(java.lang.String name)
                           throws org.ametys.plugins.repository.AmetysRepositoryException

Get a question by its name.

Parameters:

name - the question name.

Returns:

the question.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException

getQuestions

public org.ametys.plugins.repository.AmetysObjectIterable<SurveyQuestion> getQuestions()
                                                                                throws org.ametys.plugins.repository.AmetysRepositoryException

Get the survey questions.

Returns:

the survey questions.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException

getSite

public org.ametys.web.repository.site.Site getSite()
                                            throws org.ametys.plugins.repository.AmetysRepositoryException

Specified by:

getSite in interface org.ametys.web.repository.SiteAwareAmetysObject

Throws:

org.ametys.plugins.repository.AmetysRepositoryException

getSiteName

public java.lang.String getSiteName()
                             throws org.ametys.plugins.repository.AmetysRepositoryException

Specified by:

getSiteName in interface org.ametys.web.repository.SiteAwareAmetysObject

Throws:

org.ametys.plugins.repository.AmetysRepositoryException

getLanguage

public java.lang.String getLanguage()

Get the survey language.

Returns:

the survey language.

getExternalPicture

public org.ametys.plugins.repository.metadata.BinaryMetadata getExternalPicture()
                                                                         throws org.ametys.plugins.repository.AmetysRepositoryException

Get the picture as a binary metadata.

Returns:

the picture as a binary metadata.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setExternalPicture

public void setExternalPicture(java.lang.String mimeType,
                               java.lang.String filename,
                               java.io.InputStream stream)
                        throws org.ametys.plugins.repository.AmetysRepositoryException

Set the picture from an external file.

Parameters:

mimeType - the file MIME type.

filename - the file name.

stream - an input stream on the file bytes.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getResourcePictureId

public java.lang.String getResourcePictureId()
                                      throws org.ametys.plugins.repository.AmetysRepositoryException

Get the picture resource ID.

Returns:

the resource ID.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setResourcePicture

public void setResourcePicture(java.lang.String resourceId)
                        throws org.ametys.plugins.repository.AmetysRepositoryException

Set the picture from an explorer resource.

Parameters:

resourceId - the resource ID.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setNoPicture

public void setNoPicture()
                  throws org.ametys.plugins.repository.AmetysRepositoryException

Removes any picture currently assigned.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getPictureType

public java.lang.String getPictureType()
                                throws org.ametys.plugins.repository.AmetysRepositoryException

Get the picture type.

Returns:

the picture type.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setPictureType

public void setPictureType(java.lang.String type)
                    throws org.ametys.plugins.repository.AmetysRepositoryException

Set the picture type.

Parameters:

type - the picture type to set.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

getPictureAlternative

public java.lang.String getPictureAlternative()
                                       throws org.ametys.plugins.repository.AmetysRepositoryException

Get the picture alternative.

Returns:

the picture alternative.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

setPictureAlternative

public void setPictureAlternative(java.lang.String alternative)
                           throws org.ametys.plugins.repository.AmetysRepositoryException

Set the picture alternative.

Parameters:

alternative - the picture alternative to set.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException - if an error occurs.

removePictureMetas

protected void removePictureMetas()
                           throws javax.jcr.RepositoryException

Remove all picture metas (picture ID and picture binary).

Throws:

javax.jcr.RepositoryException - if an error occurs.

findUniqueQuestionName

public java.lang.String findUniqueQuestionName(java.lang.String originalName)

Returns a unique question name in the survey

Parameters:

originalName - The original name

Returns:

a unique question name

copyTo

public Survey copyTo(org.ametys.plugins.repository.ModifiableTraversableAmetysObject parent,
                     java.lang.String name)
              throws org.ametys.plugins.repository.AmetysRepositoryException

Specified by:

copyTo in interface org.ametys.plugins.repository.CopiableAmetysObject

Throws:

org.ametys.plugins.repository.AmetysRepositoryException

copyTo

public Survey copyTo(org.ametys.plugins.repository.ModifiableTraversableAmetysObject parent,
                     java.lang.String name,
                     java.util.List<java.lang.String> restrictTo)
              throws org.ametys.plugins.repository.AmetysRepositoryException

Specified by:

copyTo in interface org.ametys.plugins.repository.CopiableAmetysObject

Throws:

org.ametys.plugins.repository.AmetysRepositoryException