org.kuali.kra.questionnaire.question

Class Question

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.questionnaire.question.Question

All Implemented Interfaces:

Serializable, Comparable<Question>, org.apache.ojb.broker.PersistenceBrokerAware, Sequenceable, SequenceAssociate<Question>, SequenceOwner<Question>, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject

public class Question
extends KraPersistableBusinessObjectBase
implements Comparable<Question>, SequenceOwner<Question>

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

UPDATE_USER_LENGTH

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
Question()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Question argQuestion) The default comparator goes by the order of questionId, sequenceNumber.
String	getAffirmativeStatementConversion()
Integer	getAnswerMaxLength()
Integer	getCategoryTypeCode()
Integer	getDisplayedAnswers()
String	getDocumentNumber()
String	getExplanation()
String	getLookupClass()
String	getLookupClassDescription() This method returns the descriptive text of the lookupClass
String	getLookupReturn()
String	getLookupReturnDescription() This method returns the descriptive text of the lookupReturn
Integer	getMaxAnswers()
String	getNegativeStatementConversion()
Integer	getOwnerSequenceNumber() This method returns its owner's sequence number.
String	getPolicy()
String	getQuestion()
QuestionCategory	getQuestionCategory()
List<QuestionExplanation>	getQuestionExplanations()
String	getQuestionId()
Integer	getQuestionIdAsInteger()
Long	getQuestionRefId()
QuestionType	getQuestionType()
Integer	getQuestionTypeId()
String	getRegulation()
Integer	getSequenceNumber() This gets the current version number.
Question	getSequenceOwner() The SequenceOwner is returned; "this" should be returned if this associate is the sequence owner.
String	getSequenceStatus()
String	getStatus()
String	getVersionNameField() For Award, this would be "awardNumber", for Committee "committeeName", for Protocol "protocolNumber", etc.
void	incrementSequenceNumber() This increments sequence number on an owner of a sequence.
void	resetPersistenceState() This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity.
void	setAffirmativeStatementConversion(String affirmativeStatementConversion)
void	setAnswerMaxLength(Integer answerMaxLength)
void	setCategoryTypeCode(Integer categoryTypeCode)
void	setDisplayedAnswers(Integer displayedAnswers)
void	setDocumentNumber(String documentNumber)
void	setExplanation(String explanation)
void	setLookupClass(String lookupClass)
void	setLookupReturn(String lookupReturn)
void	setMaxAnswers(Integer maxAnswers)
void	setNegativeStatementConversion(String negativeStatementConversion)
void	setPolicy(String policy)
void	setQuestion(String question)
void	setQuestionCategory(QuestionCategory questionCategory)
void	setQuestionExplanations(List<QuestionExplanation> questionExplanations)
void	setQuestionId(String questionId)
void	setQuestionIdFromInteger(Integer questionIdAsInteger)
void	setQuestionRefId(Long questionRefId)
void	setQuestionType(QuestionType questionType)
void	setQuestionTypeId(Integer questionTypeId)
void	setRegulation(String regulation)
void	setSequenceNumber(Integer sequenceNumber)
void	setSequenceOwner(Question newlyVersionedOwner) This sets the sequence owner on the associate.
void	setSequenceStatus(String sequenceStatus)
void	setStatus(String status)

Methods inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, prePersist, preUpdate, setUpdateTimestamp, setUpdateUser, setUpdateUserSet

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postRemove, postUpdate, preRemove, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Constructor Detail

Question

public Question()

Method Detail

getDocumentNumber

public String getDocumentNumber()

setDocumentNumber

public void setDocumentNumber(String documentNumber)

getQuestionRefId

public Long getQuestionRefId()

setQuestionRefId

public void setQuestionRefId(Long questionRefId)

getQuestionId

public String getQuestionId()

getQuestionIdAsInteger

public Integer getQuestionIdAsInteger()

setQuestionId

public void setQuestionId(String questionId)

setQuestionIdFromInteger

public void setQuestionIdFromInteger(Integer questionIdAsInteger)

getSequenceNumber

public Integer getSequenceNumber()

Description copied from interface: Sequenceable

This gets the current version number.

Specified by:

getSequenceNumber in interface Sequenceable

Returns:

the sequence number

setSequenceNumber

public void setSequenceNumber(Integer sequenceNumber)

getSequenceStatus

public String getSequenceStatus()

setSequenceStatus

public void setSequenceStatus(String sequenceStatus)

getQuestion

public String getQuestion()

setQuestion

public void setQuestion(String question)

getStatus

public String getStatus()

setStatus

public void setStatus(String status)

getCategoryTypeCode

public Integer getCategoryTypeCode()

setCategoryTypeCode

public void setCategoryTypeCode(Integer categoryTypeCode)

getQuestionTypeId

public Integer getQuestionTypeId()

setQuestionTypeId

public void setQuestionTypeId(Integer questionTypeId)

getLookupClass

public String getLookupClass()

setLookupClass

public void setLookupClass(String lookupClass)

getLookupClassDescription

public String getLookupClassDescription()

This method returns the descriptive text of the lookupClass

Returns:

descriptive text

getLookupReturn

public String getLookupReturn()

setLookupReturn

public void setLookupReturn(String lookupReturn)

getLookupReturnDescription

public String getLookupReturnDescription()

This method returns the descriptive text of the lookupReturn

Returns:

descriptive text

getDisplayedAnswers

public Integer getDisplayedAnswers()

setDisplayedAnswers

public void setDisplayedAnswers(Integer displayedAnswers)

getMaxAnswers

public Integer getMaxAnswers()

setMaxAnswers

public void setMaxAnswers(Integer maxAnswers)

getAnswerMaxLength

public Integer getAnswerMaxLength()

setAnswerMaxLength

public void setAnswerMaxLength(Integer answerMaxLength)

getQuestionCategory

public QuestionCategory getQuestionCategory()

setQuestionCategory

public void setQuestionCategory(QuestionCategory questionCategory)

getQuestionType

public QuestionType getQuestionType()

setQuestionType

public void setQuestionType(QuestionType questionType)

getQuestionExplanations

public List<QuestionExplanation> getQuestionExplanations()

setQuestionExplanations

public void setQuestionExplanations(List<QuestionExplanation> questionExplanations)

getExplanation

public String getExplanation()

setExplanation

public void setExplanation(String explanation)

getPolicy

public String getPolicy()

setPolicy

public void setPolicy(String policy)

getRegulation

public String getRegulation()

setRegulation

public void setRegulation(String regulation)

getAffirmativeStatementConversion

public String getAffirmativeStatementConversion()

setAffirmativeStatementConversion

public void setAffirmativeStatementConversion(String affirmativeStatementConversion)

getNegativeStatementConversion

public String getNegativeStatementConversion()

setNegativeStatementConversion

public void setNegativeStatementConversion(String negativeStatementConversion)

compareTo

public int compareTo(Question argQuestion)

The default comparator goes by the order of questionId, sequenceNumber.

Specified by:

compareTo in interface Comparable<Question>

Parameters:

argQuestion - the Question to be compared.

Returns:

the value 0 if this Question is equal to the argument Question; a value less than 0 if this Question has a questionId & sequenceNumber pair that is less than the argument Question; and a value greater than 0 if this Question has a questionId & sequenceNumber pair that is greater than the argument Question.

getOwnerSequenceNumber

public Integer getOwnerSequenceNumber()

Description copied from interface: SequenceOwner

This method returns its owner's sequence number. If this is the top level owner; i.e. Protocol or Award, it should return null

Specified by:

getOwnerSequenceNumber in interface SequenceOwner<Question>

Returns:

the owner's sequence number

getVersionNameField

public String getVersionNameField()

Description copied from interface: SequenceOwner

For Award, this would be "awardNumber", for Committee "committeeName", for Protocol "protocolNumber", etc.

Specified by:

getVersionNameField in interface SequenceOwner<Question>

Returns:

the field name that versions are "grouped" by

incrementSequenceNumber

public void incrementSequenceNumber()

Description copied from interface: SequenceOwner

This increments sequence number on an owner of a sequence.

Specified by:

incrementSequenceNumber in interface SequenceOwner<Question>

getSequenceOwner

public Question getSequenceOwner()

Description copied from interface: SequenceAssociate

The SequenceOwner is returned; "this" should be returned if this associate is the sequence owner.

Specified by:

getSequenceOwner in interface SequenceAssociate<Question>

Returns:

the SequenceOwner

setSequenceOwner

public void setSequenceOwner(Question newlyVersionedOwner)

Description copied from interface: SequenceAssociate

This sets the sequence owner on the associate. Should no-op if this associate has no sequence owner

Specified by:

setSequenceOwner in interface SequenceAssociate<Question>

resetPersistenceState

public void resetPersistenceState()

Description copied from interface: Sequenceable

This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity. During sequencing, the VersioningService needs to be able to signal that a Sequenceable has changed state from an persisted entity to a new, unpersisted one. Otherwise, versioning operations would result earlier SequenceOwners losing the association with older versions of associates. This behavior comes into play whenever an associated object is versioned. Typically, implementers will set primary key fields to null to trigger an INSERT during save.

Specified by:

resetPersistenceState in interface Sequenceable