org.ametys.plugins.survey.repository

Class SurveyPage

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

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

org.ametys.plugins.survey.repository.SurveyPage

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 SurveyPage
extends org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject<SurveyPageFactory>
implements org.ametys.plugins.repository.CopiableAmetysObject

AmetysObject for storing survey

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SurveyPage	copyTo(org.ametys.plugins.repository.ModifiableTraversableAmetysObject parent, java.lang.String name)
SurveyPage	copyTo(org.ametys.plugins.repository.ModifiableTraversableAmetysObject parent, java.lang.String name, java.util.List<java.lang.String> restrictTo)
void	deleteRule() Delete the rule
java.lang.String	getDescription() Retrieves the description.
org.ametys.plugins.repository.metadata.BinaryMetadata	getExternalPicture() Get the picture as a binary metadata.
java.lang.String	getLabel() Retrieves the survey name.
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.
org.ametys.plugins.repository.AmetysObjectIterable<SurveyQuestion>	getQuestions() Get the page's questions.
java.lang.String	getResourcePictureId() Get the picture resource ID.
SurveyRule	getRule() Get rule
Survey	getSurvey() Get the Survey to which this page belongs.
java.lang.String	getTitle() Retrieves the title.
boolean	hasQuestion(java.lang.String name) Determines if question exists
boolean	hasRule() Determines if the page has a rule
protected void	removePictureMetas() Remove all picture metas (picture ID and picture binary).
void	setDescription(java.lang.String description) Set the description.
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 name) Set the survey name.
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	setResourcePicture(java.lang.String resourceId) Set the picture from an explorer resource.
void	setRule(SurveyRule.RuleType ruleType, java.lang.String page) Set the rule for branching
void	setTitle(java.lang.String title) Set the title.

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

SurveyPage

public SurveyPage(javax.jcr.Node node,
                  java.lang.String parentPath,
                  SurveyPageFactory factory)

Creates a SurveyPage.

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 name.

Returns:

the the survey name.

Throws:

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

setLabel

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

Set the survey name.

Parameters:

name - the survey name.

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.

setRule

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

Set the rule for branching

Parameters:

ruleType - the rule type

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

Throws:

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

deleteRule

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

Delete the rule

Throws:

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

hasRule

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

Determines if the page has a rule

Returns:

true if the page has a rule

Throws:

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

getRule

public SurveyRule getRule()
                   throws org.ametys.plugins.repository.AmetysRepositoryException

Get rule

Returns:

the rules

Throws:

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

getSurvey

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

Get the Survey to which this page belongs.

Returns:

the Survey to which this page belongs.

Throws:

org.ametys.plugins.repository.AmetysRepositoryException

hasQuestion

public boolean hasQuestion(java.lang.String name)
                    throws org.ametys.plugins.repository.AmetysRepositoryException

Determines if question exists

Parameters:

name - The question name

Returns:

true true if the question exists

Throws:

org.ametys.plugins.repository.AmetysRepositoryException

getQuestion

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

Get a question.

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 page's questions.

Returns:

the page's questions.

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