org.sakaiproject.tool.assessment.facade
Class AssessmentBaseFacade

java.lang.Object
  extended byorg.sakaiproject.tool.assessment.facade.AssessmentBaseFacade
All Implemented Interfaces:
AssessmentBaseIfc, Serializable
Direct Known Subclasses:
AssessmentFacade, AssessmentTemplateFacade

public class AssessmentBaseFacade
extends Object
implements Serializable, AssessmentBaseIfc

See Also:
Serialized Form

Field Summary
protected  org.osid.assessment.Assessment assessment
           
 
Fields inherited from interface org.sakaiproject.tool.assessment.data.ifc.assessment.AssessmentBaseIfc
ACTIVE_STATUS, DEAD_STATUS, HASMETADATAFORQUESTIONS, INACTIVE_STATUS, METADATAQUESTIONS_ISINSTRUCTOREDITABLE, SHOWFEEDBACKAUTHORING
 
Constructor Summary
AssessmentBaseFacade()
          AssessmentBaseFacade is the class that is exposed to developer It contains some of the useful methods specified in org.osid.assessment.Assessment and it implements org.sakaiproject.tool.assessment.ifc.
AssessmentBaseFacade(AssessmentBaseIfc data)
          This is a very important constructor.
 
Method Summary
 void addAssessmentMetaData(String label, String entry)
          Add a Meta Data to AssessmentFacade
 AssessmentAccessControlIfc getAssessmentAccessControl()
          Get the AccessControl of the person who last modified AssessmentBaseFacade
 Long getAssessmentBaseId()
           
 AssessmentFeedbackIfc getAssessmentFeedback()
           
 String getAssessmentMetaDataByLabel(String label)
          Get meta data by label
 HashMap getAssessmentMetaDataMap()
           
 HashMap getAssessmentMetaDataMap(Set assessmentMetaDataSet)
          Get assessment metadata in HashMap (String Label, AssessmentMetaData assessmentMetaData) of AssessmentFacade
 Set getAssessmentMetaDataSet()
           
 TypeFacade getAssessmentTypeFacade()
           
 String getComments()
          Get Comments for AssessmentBaseFacade
 String getCreatedBy()
          Get createdBy for AssessmentBaseFacade.
 Date getCreatedDate()
          Get the creation date of AssessmentBaseFacade.
 AssessmentBaseIfc getData()
          Get the data for this AssessmentBaseFacade.
 String getDescription()
           
 String getDisplayName()
           
 EvaluationModelIfc getEvaluationModel()
          Get the EvaluationModel of the person who last modified AssessmentBaseFacade
 String getHasMetaDataForQuestions()
          Convenient method to check if this is question metadata
 Integer getInstructorNotification()
          Get InstructorNotification for AssessmentBaseFacade
 Boolean getIsTemplate()
           
 String getLastModifiedBy()
          Get the agentId of the person who last modified AssessmentBaseFacade
 Date getLastModifiedDate()
          Get the date when AssessmentBaseFacade where last modified By
 String getMetaDataQuestions_isInstructorEditable()
          Convenient method to check if question metadata is editable
 Integer getMultipartAllowed()
          Get MultipartAllowed for AssessmentBaseFacade
 Long getParentId()
          Get parentId of AssessmentBaseFacade.
 Set getSecuredIPAddressSet()
           
 String getShowFeedbackAuthoring()
           
 Integer getStatus()
          Get status of AssessmentBaseFacade. 1 = active, 0 = inactive
 Integer getTesteeNotification()
          Get TesteeNotification for AssessmentBaseFacade
 String getTitle()
          Get Title for AssessmentBaseFacade
 TypeIfc getType()
           
 Long getTypeId()
           
 void setAssessmentAccessControl(AssessmentAccessControlIfc assessmentAccessControl)
          set the AccessControl of the person who last modified AssessmentBaseFacade
 void setAssessmentBaseId(Long assessmentId)
          Set assessmentId for AssessmentTemlateFacade
 void setAssessmentFeedback(AssessmentFeedbackIfc assessmentFeedback)
           
 void setAssessmentMetaDataSet(Set assessmentMetaDataSet)
          Set assessment metadata set in AssessmentBaseFacade and AssessmentBaseFacade.data
 void setComments(String comments)
          Set Comments for AssessmentBaseFacade
 void setCreatedBy(String createdBy)
          Set createdBy for AssessmentBaseFacade.
 void setCreatedDate(Date createdDate)
          Set the creation date of AssessmentBaseFacade
 void setData(AssessmentBaseIfc data)
          Set data for AssessmentBaseFacade
 void setDescription(String description)
          Set description for AssessmentBaseFacade
 void setDisplayName(String displayName)
          Set description for AssessmentBaseFacade
 void setEvaluationModel(EvaluationModelIfc evaluationModel)
          set the EvaluationModel of the person who last modified AssessmentBaseFacade
 void setInstructorNotification(Integer instructorNotification)
          Set InstructorNotification for AssessmentBaseFacade
 void setIsTemplate(Boolean isTemplate)
          Set to true if record is a assessmentTemplate
 void setLastModifiedBy(String lastModifiedBy)
          set the agentId of the person who last modified AssessmentBaseFacade
 void setLastModifiedDate(Date lastModifiedDate)
          Set the last modified date
 void setMultipartAllowed(Integer multipartAllowed)
          Set MultipartAllowed for AssessmentBaseFacade
 void setParentId(Long parentId)
          Set parentId for AssessmentBaseFacade.
 void setSecuredIPAddressSet(Set securedIPAddressSet)
           
 void setStatus(Integer status)
          Set status for AssessmentBaseFacade. 1 = active, 0 = inactive
 void setTesteeNotification(Integer testeeNotification)
          Set TesteeNotification for AssessmentBaseFacade
 void setTitle(String title)
          Set Title for AssessmentBaseFacade
 void setTypeId(Long typeId)
          Set TypeId for AssessmentBaseType.
 void updateAssessmentMetaData(String label, String entry)
           
 void updateData(AssessmentBaseIfc data)
          Call setDate() to update data in AssessmentBaseFacade
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

assessment

protected org.osid.assessment.Assessment assessment
Constructor Detail

AssessmentBaseFacade

public AssessmentBaseFacade()
AssessmentBaseFacade is the class that is exposed to developer It contains some of the useful methods specified in org.osid.assessment.Assessment and it implements org.sakaiproject.tool.assessment.ifc. When new methods is added to osid api, this code is still workable. If signature in any of the osid methods that we mirrored changes, we only need to modify those particular methods. - daisyf


AssessmentBaseFacade

public AssessmentBaseFacade(AssessmentBaseIfc data)
This is a very important constructor. Please make sure that you have set all the properties (declared above as private) of AssessmentBaseFacade using the "data" supplied. "data" is a org.osid.assessment.Assessment properties and I use it to store info about an assessment.

Parameters:
data -
Method Detail

getType

public TypeIfc getType()
Specified by:
getType in interface AssessmentBaseIfc

getAssessmentTypeFacade

public TypeFacade getAssessmentTypeFacade()

getData

public AssessmentBaseIfc getData()
Get the data for this AssessmentBaseFacade.

Returns:
AssessmentDataIfc

updateData

public void updateData(AssessmentBaseIfc data)
Call setDate() to update data in AssessmentBaseFacade

Parameters:
data -

setData

public void setData(AssessmentBaseIfc data)
             throws org.osid.assessment.AssessmentException
Set data for AssessmentBaseFacade

Parameters:
data -
Throws:
org.osid.assessment.AssessmentException

getAssessmentBaseId

public Long getAssessmentBaseId()
                         throws DataFacadeException
Specified by:
getAssessmentBaseId in interface AssessmentBaseIfc
Throws:
DataFacadeException

setAssessmentBaseId

public void setAssessmentBaseId(Long assessmentId)
Set assessmentId for AssessmentTemlateFacade

Specified by:
setAssessmentBaseId in interface AssessmentBaseIfc
Parameters:
assessmentId -

getIsTemplate

public Boolean getIsTemplate()
                      throws DataFacadeException
Specified by:
getIsTemplate in interface AssessmentBaseIfc
Throws:
DataFacadeException

setIsTemplate

public void setIsTemplate(Boolean isTemplate)
Set to true if record is a assessmentTemplate

Specified by:
setIsTemplate in interface AssessmentBaseIfc

getDisplayName

public String getDisplayName()
                      throws DataFacadeException
Throws:
DataFacadeException

setDisplayName

public void setDisplayName(String displayName)
Set description for AssessmentBaseFacade


getDescription

public String getDescription()
                      throws DataFacadeException
Specified by:
getDescription in interface AssessmentBaseIfc
Throws:
DataFacadeException

setDescription

public void setDescription(String description)
Set description for AssessmentBaseFacade

Specified by:
setDescription in interface AssessmentBaseIfc
Parameters:
description -

getTypeId

public Long getTypeId()
               throws DataFacadeException
Specified by:
getTypeId in interface AssessmentBaseIfc
Throws:
DataFacadeException

setTypeId

public void setTypeId(Long typeId)
Set TypeId for AssessmentBaseType. This property is used to indicate an assessment type. e.g. 11 = Quiz, 12 = Homework, 13 = Mid Term. Please check out ddl/02_TypeData.sql and table "type".

Specified by:
setTypeId in interface AssessmentBaseIfc
Parameters:
typeId -

getParentId

public Long getParentId()
                 throws DataFacadeException
Get parentId of AssessmentBaseFacade.

Specified by:
getParentId in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

setParentId

public void setParentId(Long parentId)
Set parentId for AssessmentBaseFacade.

Specified by:
setParentId in interface AssessmentBaseIfc
Parameters:
parentId -

getTitle

public String getTitle()
                throws DataFacadeException
Get Title for AssessmentBaseFacade

Specified by:
getTitle in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

setTitle

public void setTitle(String title)
Set Title for AssessmentBaseFacade

Specified by:
setTitle in interface AssessmentBaseIfc
Parameters:
title -

setComments

public void setComments(String comments)
Set Comments for AssessmentBaseFacade

Specified by:
setComments in interface AssessmentBaseIfc
Parameters:
comments -

getComments

public String getComments()
                   throws DataFacadeException
Get Comments for AssessmentBaseFacade

Specified by:
getComments in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

setInstructorNotification

public void setInstructorNotification(Integer instructorNotification)
Set InstructorNotification for AssessmentBaseFacade

Specified by:
setInstructorNotification in interface AssessmentBaseIfc
Parameters:
instructorNotification -

getInstructorNotification

public Integer getInstructorNotification()
                                  throws DataFacadeException
Get InstructorNotification for AssessmentBaseFacade

Specified by:
getInstructorNotification in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

setTesteeNotification

public void setTesteeNotification(Integer testeeNotification)
Set TesteeNotification for AssessmentBaseFacade

Specified by:
setTesteeNotification in interface AssessmentBaseIfc
Parameters:
testeeNotification -

getTesteeNotification

public Integer getTesteeNotification()
                              throws DataFacadeException
Get TesteeNotification for AssessmentBaseFacade

Specified by:
getTesteeNotification in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

setMultipartAllowed

public void setMultipartAllowed(Integer multipartAllowed)
Set MultipartAllowed for AssessmentBaseFacade

Specified by:
setMultipartAllowed in interface AssessmentBaseIfc
Parameters:
multipartAllowed -

getMultipartAllowed

public Integer getMultipartAllowed()
                            throws DataFacadeException
Get MultipartAllowed for AssessmentBaseFacade

Specified by:
getMultipartAllowed in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

getStatus

public Integer getStatus()
                  throws DataFacadeException
Get status of AssessmentBaseFacade. 1 = active, 0 = inactive

Specified by:
getStatus in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

setStatus

public void setStatus(Integer status)
Set status for AssessmentBaseFacade. 1 = active, 0 = inactive

Specified by:
setStatus in interface AssessmentBaseIfc
Parameters:
status -

getCreatedBy

public String getCreatedBy()
                    throws DataFacadeException
Get createdBy for AssessmentBaseFacade. This represents the agentId of the person who created the record

Specified by:
getCreatedBy in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

setCreatedBy

public void setCreatedBy(String createdBy)
Set createdBy for AssessmentBaseFacade. This represents the agentId of the person who created the record

Specified by:
setCreatedBy in interface AssessmentBaseIfc
Parameters:
createdBy -

getCreatedDate

public Date getCreatedDate()
                    throws DataFacadeException
Get the creation date of AssessmentBaseFacade.

Specified by:
getCreatedDate in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

setCreatedDate

public void setCreatedDate(Date createdDate)
Set the creation date of AssessmentBaseFacade

Specified by:
setCreatedDate in interface AssessmentBaseIfc
Parameters:
createdDate -

getLastModifiedBy

public String getLastModifiedBy()
                         throws DataFacadeException
Get the agentId of the person who last modified AssessmentBaseFacade

Specified by:
getLastModifiedBy in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

setLastModifiedBy

public void setLastModifiedBy(String lastModifiedBy)
set the agentId of the person who last modified AssessmentBaseFacade

Specified by:
setLastModifiedBy in interface AssessmentBaseIfc
Parameters:
lastModifiedBy -

getLastModifiedDate

public Date getLastModifiedDate()
                         throws DataFacadeException
Get the date when AssessmentBaseFacade where last modified By

Specified by:
getLastModifiedDate in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

setLastModifiedDate

public void setLastModifiedDate(Date lastModifiedDate)
Set the last modified date

Specified by:
setLastModifiedDate in interface AssessmentBaseIfc

getAssessmentAccessControl

public AssessmentAccessControlIfc getAssessmentAccessControl()
                                                      throws DataFacadeException
Get the AccessControl of the person who last modified AssessmentBaseFacade

Specified by:
getAssessmentAccessControl in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

setAssessmentAccessControl

public void setAssessmentAccessControl(AssessmentAccessControlIfc assessmentAccessControl)
set the AccessControl of the person who last modified AssessmentBaseFacade

Specified by:
setAssessmentAccessControl in interface AssessmentBaseIfc
Parameters:
assessmentAccessControl -

getEvaluationModel

public EvaluationModelIfc getEvaluationModel()
                                      throws DataFacadeException
Get the EvaluationModel of the person who last modified AssessmentBaseFacade

Specified by:
getEvaluationModel in interface AssessmentBaseIfc
Returns:
Throws:
DataFacadeException

setEvaluationModel

public void setEvaluationModel(EvaluationModelIfc evaluationModel)
set the EvaluationModel of the person who last modified AssessmentBaseFacade

Specified by:
setEvaluationModel in interface AssessmentBaseIfc
Parameters:
evaluationModel -

getAssessmentFeedback

public AssessmentFeedbackIfc getAssessmentFeedback()
Specified by:
getAssessmentFeedback in interface AssessmentBaseIfc

setAssessmentFeedback

public void setAssessmentFeedback(AssessmentFeedbackIfc assessmentFeedback)
Specified by:
setAssessmentFeedback in interface AssessmentBaseIfc

getSecuredIPAddressSet

public Set getSecuredIPAddressSet()
Specified by:
getSecuredIPAddressSet in interface AssessmentBaseIfc

setSecuredIPAddressSet

public void setSecuredIPAddressSet(Set securedIPAddressSet)
Specified by:
setSecuredIPAddressSet in interface AssessmentBaseIfc

getAssessmentMetaDataSet

public Set getAssessmentMetaDataSet()
                             throws DataFacadeException
Specified by:
getAssessmentMetaDataSet in interface AssessmentBaseIfc
Throws:
DataFacadeException

setAssessmentMetaDataSet

public void setAssessmentMetaDataSet(Set assessmentMetaDataSet)
Set assessment metadata set in AssessmentBaseFacade and AssessmentBaseFacade.data

Specified by:
setAssessmentMetaDataSet in interface AssessmentBaseIfc
Parameters:
assessmentMetaDataSet -

getAssessmentMetaDataMap

public HashMap getAssessmentMetaDataMap(Set assessmentMetaDataSet)
Get assessment metadata in HashMap (String Label, AssessmentMetaData assessmentMetaData) of AssessmentFacade

Specified by:
getAssessmentMetaDataMap in interface AssessmentBaseIfc
Parameters:
assessmentMetaDataSet -
Returns:

getAssessmentMetaDataMap

public HashMap getAssessmentMetaDataMap()
Specified by:
getAssessmentMetaDataMap in interface AssessmentBaseIfc

getAssessmentMetaDataByLabel

public String getAssessmentMetaDataByLabel(String label)
Get meta data by label

Specified by:
getAssessmentMetaDataByLabel in interface AssessmentBaseIfc
Parameters:
label -
Returns:

getMetaDataQuestions_isInstructorEditable

public String getMetaDataQuestions_isInstructorEditable()
Convenient method to check if question metadata is editable


getHasMetaDataForQuestions

public String getHasMetaDataForQuestions()
Convenient method to check if this is question metadata


getShowFeedbackAuthoring

public String getShowFeedbackAuthoring()

addAssessmentMetaData

public void addAssessmentMetaData(String label,
                                  String entry)
Add a Meta Data to AssessmentFacade

Specified by:
addAssessmentMetaData in interface AssessmentBaseIfc
Parameters:
label -
entry -

updateAssessmentMetaData

public void updateAssessmentMetaData(String label,
                                     String entry)
Specified by:
updateAssessmentMetaData in interface AssessmentBaseIfc