WHERE clause of
* some SQL representing the criteria upon which to select the
* result.
* @return the required result.
*/
public static QuestionnaireResult findQuestionnaireResult( String whereSQL )
throws BuildingServerException
{
return (QuestionnaireResult)findPersistentObject(
whereSQL, QuestionnaireResult.class.getName() );
}
/**
* Find the specified results.
* @param whereSQL a string representing the WHERE clause of
* some SQL representing the criteria upon which to select the
* results.
* @return an enumeration of instances of this class.
*/
public static Enumeration findQuestionnaireResults( String whereSQL )
throws BuildingServerException
{
return findPersistentObjects( whereSQL, QuestionnaireResult.class.getName() );
}
/**
* Find the specified results.
* @param whereSQL a string representing the WHERE clause of
* some SQL representing the criteria upon which to select the
* results.
* @param orderSQL a string representing the ORDER BY clause of
* some SQL representing the criteria upon which to order the
* results.
* @return an enumeration of instances of this class.
*/
public static Enumeration findQuestionnaireResults( String whereSQL, String orderSQL )
throws BuildingServerException
{
return findPersistentObjects( whereSQL, orderSQL, QuestionnaireResult.class.getName() );
}
/**
* Find the specified results. This method provides a way of retrieving all
* the results to a given questionnaire.
* @param questionnaireID the ID of the questionnaire.
* @return an enumeration of results matching the search criteria.
* @see #getQuestionnaireId()
*/
public static Enumeration findQuestionnaireResults(
PrimaryKey questionnaireID ) throws BuildingServerException
{
return findQuestionnaireResults( "resource_id = " + questionnaireID );
}
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}>
*
*
*
* If a given question has no response, the map will return
* null.
* @return a map of the responses associated with this instance.
* @see QuestionnaireResponse
*/
public Map getQuestionnaireResponses()
throws BuildingServerException
{
Hashtable map = new Hashtable();
// Query what the recorded responses are.
Enumeration responses
= QuestionnaireResponse.findQuestionnaireResponses(
"questionnaire_result_id = " + getPrimaryKey() );
while ( responses.hasMoreElements() )
{
QuestionnaireResponse response
= (QuestionnaireResponse)responses.nextElement();
map.put( response.getQuestionnaireQuestionId(), response );
}
return map;
}
/**
* 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;
}
}
}