isRecorded parameter indicates whether or not this
* instances represents a recorded result.
* @param isRecorded indicates whether or not this instance represents a
* recorded result.
* @see #isRecorded()
*/
public QuestionnaireResult(boolean isRecorded)
{
this.isRecorded = isRecorded;
}
public static QuestionnaireResult findQuestionnaireResult( PrimaryKey key )
throws BuildingServerException
{
QuestionnaireResult result = (QuestionnaireResult)findPersistentObject(
key, "org.bodington.server.assessment.QuestionnaireResult" );
return (result != null) ? result : new QuestionnaireResult(false);
}
public static QuestionnaireResult findQuestionnaireResult( String where )
throws BuildingServerException
{
QuestionnaireResult result = (QuestionnaireResult)findPersistentObject(
where, "org.bodington.assessment.QuestionnaireResult" );
return (result != null) ? result : new QuestionnaireResult(false);
}
public static Enumeration findQuestionnaireResults( String where )
throws BuildingServerException
{
return findPersistentObjects( where, "org.bodington.assessment.QuestionnaireResult" );
}
public static Enumeration findQuestionnaireResults( String where, String order )
throws BuildingServerException
{
return findPersistentObjects( where, order, "org.bodington.assessment.QuestionnaireResult" );
}
public PrimaryKey getPrimaryKey()
{
return primary_key;
}
public void setPrimaryKey(PrimaryKey key)
{
primary_key = key;
setUnsaved();
}
public PrimaryKey getQuestionnaireResultId()
{
return getPrimaryKey();
}
public void setQuestionnaireResultId( PrimaryKey id )
{
setPrimaryKey(id);
}
/**
* Kept for backwards compatibility. This class is not an
* instance of {@link org.bodington.server.resources.Resource} therefore it
* should not have this method. Unfortunately, it's use is embedded in the
* persistence layer so it is maintained for the time being. In practice,
* the value of this property is synonymous with
* {@link #getQuestionnaireId()}, which is why you should call that method
* directly instead.
* @return the ID.
* @deprecated Use {@link #getQuestionnaireId()} instead.
*/
public PrimaryKey getResourceId()
{
return getQuestionnaireId();
}
/**
* Kept for backwards compatibility. This class is not an
* instance of {@link org.bodington.server.resources.Resource} therefore it
* should not have this method. Unfortunately, it's use is embedded in the
* persistence layer so it is maintained for the time being.
* @param id the ID to set.
* @deprecated Use {@link #setQuestionnaireId(PrimaryKey)} instead.
* @see #getResourceId()
*/
public void setResourceId( PrimaryKey id )
{
setQuestionnaireId(id);
}
/**
* Get the ID of the user to which this response refers.
* @return the ID of the user to which this response refers.
* @see org.bodington.server.realm.User
*/
public PrimaryKey getUserId()
{
return user_id;
}
/**
* Set the ID of the user to which this response refers.
* @param id the ID of the user to which this response refers.
* @see #getUserId()
*/
public void setUserId( PrimaryKey id )
{
user_id = id;
setUnsaved();
}
/**
* Get the time stamp of when the user started recording their response.
* @return the time stamp of when the user started recording their response.
*/
public Timestamp getWhenStarted()
{
return when_started;
}
/**
* Set the time stamp of when the user started recording their response.
* @param t the time stamp of when the user started recording their response.
* @see #getWhenStarted()
*/
public void setWhenStarted( Timestamp t )
{
when_started = t;
setUnsaved();
}
/**
* Get the time stamp of when this object was saved to the database.
* @return the time stamp of when this object was saved to the database.
*/
public Timestamp getWhenSaved()
{
return when_saved;
}
/**
* Set the time stamp of when this object was saved to the database.
* @param t the time stamp of when this object was saved to the database.
* @see #getWhenSaved()
*/
public void setWhenSaved( Timestamp t )
{
when_saved = t;
setUnsaved();
}
/**
* Get a map of the responses associated with this instance. The form of the
* returned map is as follows:
*
*
*
* Map <{@link QuestionnaireResponse#getQuestionnaireQuestionId()},
* {@link QuestionnaireResponse}>
*
*
*
* For each question in the questionnaire, there will be a corresponding
* response within the map. If there is no response recorded in the
* database, then the {@link QuestionnaireResponse#isRecorded()} method for
* that response will return false.
* @return a map of the responses associated with this instance.
* @see QuestionnaireResponse
* @see QuestionnaireResponse#isRecorded()
*/
public Map getQuestionnaireResponses()
throws RemoteException, BuildingServerException
{
Hashtable map = new Hashtable();
if (!isRecorded())
return map;
// First of all, populate the map with 'blank' responses.
Iterator questions = getQuestionnaire().getQuestions().iterator();
while (questions.hasNext())
{
QuestionnaireQuestion question
= (QuestionnaireQuestion) questions.next();
map.put(question.getQuestionnaireQuestionId(),
new QuestionnaireResponse(this, false));
}
// Query what the recorded responses are.
Enumeration responses
= QuestionnaireResponse.findQuestionnaireResponses(
"questionnaire_result_id = " + getPrimaryKey() );
// Overwrite the blank responses with any recorded responses.
while ( responses.hasMoreElements() )
{
QuestionnaireResponse response
= (QuestionnaireResponse)responses.nextElement();
map.put( response.getQuestionnaireQuestionId(), response );
}
return map;
}
/**
* Indicates whether this instance represents a recorded result. A result
* of true means that there is a persistent record of the
* associated users result in the database. A result of false
* indicates that no result has yet been recorded. This latter case is
* especially relevant in the case of single-session questionnaires.
* @return true if this instance represents a submitted result,
* otherwise false.
* @see Questionnaire#isRecordOnce()
* @see #QuestionnaireResult(boolean)
*/
public boolean isRecorded()
{
return isRecorded;
}
/**
* Get the ID of the associated questionnaire. This is the questionnaire to
* which this instance is a result.
*
* NOTE: for legacy reasons, the corresponding name for this field in the
* persistence layer is currently resource_id.
* @return the ID of the associated questionnaire.
*/
public PrimaryKey getQuestionnaireId()
{
return questionnaire_id;
}
/**
* Set the ID of the associated questionnaire.
* @param id the ID of the associated questionnaire.
* @see #getQuestionnaireId()
*/
public void setQuestionnaireId(PrimaryKey id)
{
questionnaire_id = id;
setUnsaved();
}
/**
* Get the associated questionnaire. This is the questionnaire
* to which this object is a users questionnaire result.
* @return the associated questionnaire.
* @see #getQuestionnaireId()
*/
public Questionnaire getQuestionnaire()
{
// TODO: we could cache this as an instance variable:
try
{
return Questionnaire.findQuestionnaire(getQuestionnaireId());
}
catch (BuildingServerException e)
{
return null;
}
}
}