org.ametys.plugins.survey.repository

Class SurveyQuestion

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

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

org.ametys.plugins.survey.repository.SurveyQuestion

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

public class SurveyQuestion
extends org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject<SurveyQuestionFactory>
implements org.ametys.plugins.repository.CopiableAmetysObject

AmetysObject for storing survey

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SurveyQuestion.QuestionType Type of a page.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPTION_NAME_PREFIX Prefix for options

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addRules(java.lang.String option, SurveyRule.RuleType ruleType, java.lang.String page) Add a rule for branching
SurveyQuestion	copyTo(org.ametys.plugins.repository.ModifiableTraversableAmetysObject parent, java.lang.String name)
SurveyQuestion	copyTo(org.ametys.plugins.repository.ModifiableTraversableAmetysObject parent, java.lang.String name, java.util.List<java.lang.String> restrictTo)
void	deleteRule(java.lang.String option) Delete a rule
java.util.Map<java.lang.String,java.lang.String>	getColumns() Get columns
org.ametys.plugins.repository.metadata.BinaryMetadata	getExternalPicture() Get the picture as a binary metadata.
java.lang.String	getLabel() Retrieves the label.
java.util.Map<java.lang.String,java.lang.String>	getOptions() Get options
java.lang.String	getPictureAlternative() Get the picture alternative.
java.lang.String	getPictureType() Get the picture type.
java.lang.String	getRegExpPattern() Get the validation pattern.
java.lang.String	getRegExpType() Retrieves the regexp type.
java.lang.String	getResourcePictureId() Get the picture resource ID.
java.util.List<SurveyRule>	getRules() Get the rules
Survey	getSurvey() Get the survey to which this question belongs.
SurveyPage	getSurveyPage() Get the page to which this question belongs.
java.lang.String	getTitle() Retrieves the title.
SurveyQuestion.QuestionType	getType() Retrieves the title.
boolean	hasOtherOption() Determines if the question has a "other" option
boolean	hasRule(java.lang.String option) Determines if a rule with given option exists
boolean	isMandatory() Determines if the question is mandatory.
protected void	removePictureMetas() Remove all picture metas (picture ID and picture binary).
void	setColumns(java.util.Map<java.lang.String,java.lang.String> columns) Set columns
void	setExternalPicture(java.lang.String mimeType, java.lang.String filename, java.io.InputStream stream) Set the picture from an external file.
void	setLabel(java.lang.String label) Set the label.
void	setMandatory(boolean mandatory) Set the mandatory.
void	setNoPicture() Removes any picture currently assigned.
void	setOptions(java.util.Map<java.lang.String,java.lang.String> options) Set options
void	setOtherOption(boolean other) Set the "other" option.
void	setPictureAlternative(java.lang.String alternative) Set the picture alternative.
void	setPictureType(java.lang.String type) Set the picture type.
void	setRegExpType(java.lang.String regexp) Set the regexp type.
void	setResourcePicture(java.lang.String resourceId) Set the picture from an explorer resource.
void	setTitle(java.lang.String title) Set the title.
void	setType(SurveyQuestion.QuestionType type) Set the type.

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

Field Detail

OPTION_NAME_PREFIX

public static final java.lang.String OPTION_NAME_PREFIX

Prefix for options

See Also:

Constant Field Values

Constructor Detail

SurveyQuestion

public SurveyQuestion(javax.jcr.Node node,
                      java.lang.String parentPath,
                      SurveyQuestionFactory factory)

Creates a SurveyQuestion.

Parameters:

node - the node backing this AmetysObject.

parentPath - the parent path in the Ametys hierarchy.

factory - the SurveyFactory which creates the AmetysObject.

Method Detail

getLabel

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

Retrieves the label.

Returns:

the 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 label.

Parameters:

label - the label.

Throws:

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

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.

getType

public SurveyQuestion.QuestionType getType()
                                    throws org.ametys.plugins.repository.AmetysRepositoryException

Retrieves the title.

Returns:

the title.

Throws:

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

setType

public void setType(SurveyQuestion.QuestionType type)
             throws org.ametys.plugins.repository.AmetysRepositoryException

Set the type.

Parameters:

type - the type.

Throws:

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

getRegExpType

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

Retrieves the regexp type.

Returns:

the regexp type.

Throws:

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

setRegExpType

public void setRegExpType(java.lang.String regexp)
                   throws org.ametys.plugins.repository.AmetysRepositoryException

Set the regexp type.

Parameters:

regexp - the regexp type.

Throws:

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

getRegExpPattern

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

Get the validation pattern.

Returns:

the validation pattern.

Throws:

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

isMandatory

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

Determines if the question is mandatory.

Returns:

true if the question is mandatory.

Throws:

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

setMandatory

public void setMandatory(boolean mandatory)
                  throws org.ametys.plugins.repository.AmetysRepositoryException

Set the mandatory.

Parameters:

mandatory - true for mandatory

Throws:

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

hasOtherOption

public boolean hasOtherOption()

Determines if the question has a "other" option

Returns:

true if the question has a "other" option

setOtherOption

public void setOtherOption(boolean other)

Set the "other" option. To be used only for single or multiple choice question

Parameters:

other - true to add the "other" option

setOptions

public void setOptions(java.util.Map<java.lang.String,java.lang.String> options)
                throws org.ametys.plugins.repository.AmetysRepositoryException

Set options

Parameters:

options - the options as a Map of key, value

Throws:

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

getOptions

public java.util.Map<java.lang.String,java.lang.String> getOptions()
                                                            throws org.ametys.plugins.repository.AmetysRepositoryException

Get options

Returns:

the options as a Map of key, value

Throws:

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

setColumns

public void setColumns(java.util.Map<java.lang.String,java.lang.String> columns)
                throws org.ametys.plugins.repository.AmetysRepositoryException

Set columns

Parameters:

columns - the columns as a Map of key, value

Throws:

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

getColumns

public java.util.Map<java.lang.String,java.lang.String> getColumns()
                                                            throws org.ametys.plugins.repository.AmetysRepositoryException

Get columns

Returns:

the columns as a Map of key, value

Throws:

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

addRules

public void addRules(java.lang.String option,
                     SurveyRule.RuleType ruleType,
                     java.lang.String page)
              throws org.ametys.plugins.repository.AmetysRepositoryException

Add a rule for branching

Parameters:

option - the chosen option

ruleType - the rule type

page - the page to jump or skip. Can be null.

Throws:

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

hasRule

public boolean hasRule(java.lang.String option)
                throws org.ametys.plugins.repository.AmetysRepositoryException

Determines if a rule with given option exists

Parameters:

option - the option

Returns:

true if teh rule exists

Throws:

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

deleteRule

public void deleteRule(java.lang.String option)
                throws org.ametys.plugins.repository.AmetysRepositoryException

Delete a rule

Parameters:

option - the option to delete

Throws:

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

getRules

public java.util.List<SurveyRule> getRules()
                                    throws org.ametys.plugins.repository.AmetysRepositoryException

Get the rules

Returns:

the rules

Throws:

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

getSurveyPage

public SurveyPage getSurveyPage()
                         throws org.ametys.plugins.repository.AmetysRepositoryException

Get the page to which this question belongs.

Returns:

the page to which this question belongs.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException

getSurvey

public Survey getSurvey()
                 throws org.ametys.plugins.repository.AmetysRepositoryException

Get the survey to which this question belongs.

Returns:

the survey to which this question belongs.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException

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.

copyTo

public SurveyQuestion 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 SurveyQuestion 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