org.memdoc.www.yosemite.webservices.memdoc.formManagement

Class Subform

java.lang.Object

org.memdoc.www.yosemite.webservices.memdoc.formManagement.Subform

All Implemented Interfaces:

java.io.Serializable

public class Subform
extends java.lang.Object
implements java.io.Serializable

Object representation of a subform. This class describes the data needed to make a subform. It doesnt describe the layout and the look and feel but the general architecture of the subform with it's sections, groups and questions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Subform()

Method Summary

Modifier and Type	Method and Description
java.util.Calendar	getCreationDate() getter method for the creationDate attribute
java.lang.String	getDefaultName() getter method for the defaultName attribute
FormName	getName() getter method for the name attribute
int	getScoreType() getter method for the scoreType attribute
Section[]	getSections() getter method for the sections attribute
long	getSubformId() getter method for the subformId attribute
java.lang.String	getVersion() getter method for the version attribute
boolean	isHidden() getter method for the hidden attribute
boolean	isOptional() getter method for the optional attribute
void	setCreationDate(java.util.Calendar creationDate) setter method for the creationDate attribute
void	setDefaultName(java.lang.String defaultName) setter method for the defaultName attribute
void	setHidden(boolean hidden) setter method for the hidden attribute
void	setName(FormName name) setter method for the names attribute
void	setOptional(boolean optional) setter method for the optional attribute
void	setScoreType(int scoreType) setter method for the scoreType attribute
void	setSections(Section[] sections) setter method for the sections attribute
void	setSubformId(long subformId) setter method for the subformId attribute
void	setVersion(java.lang.String version) setter method for the version attribute

Methods inherited from class java.lang.Object

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

Constructor Detail

Subform

public Subform()

Method Detail

getCreationDate

public java.util.Calendar getCreationDate()

getter method for the creationDate attribute

Returns:

Returns the creation date of the subform

setCreationDate

public void setCreationDate(java.util.Calendar creationDate)

setter method for the creationDate attribute

Parameters:

creationDate - the creation date of the subform

getDefaultName

public java.lang.String getDefaultName()

getter method for the defaultName attribute

Returns:

Returns the default name of the subform

setDefaultName

public void setDefaultName(java.lang.String defaultName)

setter method for the defaultName attribute

Parameters:

defaultName - the default name of the subform

isHidden

public boolean isHidden()

getter method for the hidden attribute

Returns:

Returns true if the subform is an hidden subform

setHidden

public void setHidden(boolean hidden)

setter method for the hidden attribute

Parameters:

hidden - a boolean value that is true is the subform is a hidden subform

getName

public FormName getName()

getter method for the name attribute

Returns:

Returns the translation of the name of the subform

setName

public void setName(FormName name)

setter method for the names attribute

Parameters:

name - The translation of the name of the subform

isOptional

public boolean isOptional()

getter method for the optional attribute

Returns:

Returns true if the subform is an optional subform

setOptional

public void setOptional(boolean optional)

setter method for the optional attribute

Parameters:

optional - a flag to check whether this subform is optional or not

getScoreType

public int getScoreType()

getter method for the scoreType attribute

Returns:

Returns a score type value from 0 to 26 (see documentation for the calculation process of scores and the way to return the score results)

setScoreType

public void setScoreType(int scoreType)

setter method for the scoreType attribute

Parameters:

scoreType - a score type value from 0 to 26 (see documentation for the calculation process of scores and the way to return the score results)

getSections

public Section[] getSections()

getter method for the sections attribute

Returns:

Returns an array of ALL the sections of this subform

setSections

public void setSections(Section[] sections)

setter method for the sections attribute

Parameters:

sections - an array of ALL the sections of this subform

getSubformId

public long getSubformId()

getter method for the subformId attribute

Returns:

Returns the id of the subform

setSubformId

public void setSubformId(long subformId)

setter method for the subformId attribute

Parameters:

subformId - the id of the subform

getVersion

public java.lang.String getVersion()

getter method for the version attribute

Returns:

Returns the version of this subform

setVersion

public void setVersion(java.lang.String version)

setter method for the version attribute

Parameters:

version - the version of this subform