com.objectplanet.survey.plugin.api

Class SurveySection

java.lang.Object

com.objectplanet.survey.plugin.api.SurveySection

public class SurveySection
extends java.lang.Object

This class encapsulates survey section data. See the Opinio documentation to get to know the different survey section attributes.

Author:

Rikard Halvorsen

Created:

01. December 2004

Method Summary

Modifier and Type	Method and Description
boolean	containsQuestion(int questionNo) Returns true if question with specified question number is on the page.
java.lang.String	getCustomAttribute(java.lang.String key) Gets the specified custom attribute value from the section
java.util.HashMap	getCustomAttributes() Gets the custom attributes set for the section
int	getFromQuestion() Gets the from question
boolean	getPageBreak() Gets the pageBreak value, true if pageBreak after section
boolean	getRandomQuestionOrder() Gets the randomQuestionOrder value, true if random question order is turned on
long	getSectionId() Gets the section id
java.lang.String	getSectionText(int key) Gets the section text attribute positioned at index in sectionTextList
java.util.ArrayList	getSectionTextList() Gets the sectionTextList for the section
java.lang.String	getTitle() Gets the section title
java.lang.String	getTitleBgColor() Gets the titleBgColor value
java.lang.String	getTitleColor() Gets the titleColor value
java.lang.String	getTitleFont() Gets the titleFont value
int	getTitleSize() Gets the titleSize value
int	getToQuestion() Gets the to question
boolean	isIntroSection() Gets the introSection value, true if section is intro section

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCustomAttribute

public java.lang.String getCustomAttribute(java.lang.String key)
                                    throws SurveySystemException

Gets the specified custom attribute value from the section

Parameters:

key - The attribute key

Returns:

The attribute value

Throws:

SurveySystemException

getCustomAttributes

public java.util.HashMap getCustomAttributes()
                                      throws SurveySystemException

Gets the custom attributes set for the section

Returns:

The custom attributes

Throws:

SurveySystemException

getFromQuestion

public int getFromQuestion()
                    throws SurveySystemException

Gets the from question

Returns:

The fromQuestion value

Throws:

SurveySystemException

getPageBreak

public boolean getPageBreak()
                     throws SurveySystemException

Gets the pageBreak value, true if pageBreak after section

Returns:

The pageBreak value

Throws:

SurveySystemException

getSectionTextList

public java.util.ArrayList getSectionTextList()
                                       throws SurveySystemException

Gets the sectionTextList for the section

Returns:

The sectionTextList

Throws:

SurveySystemException

getSectionText

public java.lang.String getSectionText(int key)
                                throws SurveySystemException

Gets the section text attribute positioned at index in sectionTextList

Parameters:

key - The position in section

Returns:

The sectionText value

Throws:

SurveySystemException

getSectionId

public long getSectionId()
                  throws SurveySystemException

Gets the section id

Returns:

The section id

Throws:

SurveySystemException

getTitle

public java.lang.String getTitle()
                          throws SurveySystemException

Gets the section title

Returns:

The title value

Throws:

SurveySystemException

getTitleBgColor

public java.lang.String getTitleBgColor()
                                 throws SurveySystemException

Gets the titleBgColor value

Returns:

The titleBgColor value

Throws:

SurveySystemException

getTitleColor

public java.lang.String getTitleColor()
                               throws SurveySystemException

Gets the titleColor value

Returns:

The titleColor value

Throws:

SurveySystemException

getTitleFont

public java.lang.String getTitleFont()
                              throws SurveySystemException

Gets the titleFont value

Returns:

The titleFont value

Throws:

SurveySystemException

getTitleSize

public int getTitleSize()
                 throws SurveySystemException

Gets the titleSize value

Returns:

The titleSize value

Throws:

SurveySystemException

getRandomQuestionOrder

public boolean getRandomQuestionOrder()
                               throws SurveySystemException

Gets the randomQuestionOrder value, true if random question order is turned on

Returns:

The randomQuestionOrder value

Throws:

SurveySystemException

getToQuestion

public int getToQuestion()
                  throws SurveySystemException

Gets the to question

Returns:

The toQuestion value

Throws:

SurveySystemException

containsQuestion

public boolean containsQuestion(int questionNo)
                         throws SurveySystemException

Returns true if question with specified question number is on the page.

Parameters:

questionNo - Question number

Returns:

True if the question is on the page

Throws:

SurveySystemException

isIntroSection

public boolean isIntroSection()
                       throws SurveySystemException

Gets the introSection value, true if section is intro section

Returns:

The introPage value

Throws:

SurveySystemException