org.sakaiproject.tool.assessment.services.assessment

Class AssessmentService

java.lang.Object

org.sakaiproject.tool.assessment.services.assessment.AssessmentService

Direct Known Subclasses:

PublishedAssessmentService

public class AssessmentService
extends Object

The AssessmentService calls the service locator to reach the manager on the back end.

Author:

Rachel Gollub

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ESCAPE_CHARS_IN_RESOURCE_ID These characters are allowed; but if escapeResourceName() is called, they are escaped (actually, removed) Certain characters cause problems with filenames in certain OSes - so get rid of these characters in filenames
static String	INVALID_CHARS_IN_RESOURCE_ID These characters are not allowed in a resource id
protected static String	MAP_TO_A
protected static String	MAP_TO_B
protected static String	MAP_TO_C
protected static String	MAP_TO_E
protected static String	MAP_TO_I
protected static String	MAP_TO_L
protected static String	MAP_TO_N
protected static String	MAP_TO_O
protected static String	MAP_TO_U
protected static String	MAP_TO_X
protected static String	MAP_TO_Y
static int	UPDATE_ERROR_DRAW_SIZE_TOO_LARGE
static int	UPDATE_SUCCESS

Constructor Summary

Constructors

Constructor and Description
AssessmentService() Creates a new QuestionPoolService object.

Method Summary

Modifier and Type	Method and Description
SectionFacade	addSection(String assessmentId) public int checkDelete(long assessmentId){ return assessmentService.checkDelete(assessmentId); } public void deleteAssessment(Id assessmentId) throws osid.assessment.AssessmentException { assessmentService.deleteAssessment(assessmentId); } public AssessmentIterator getAssessments() throws osid.assessment.AssessmentException { return assessmentService.getAssessments(); }
boolean	assessmentTitleIsUnique(String assessmentBaseId, String title, boolean isTemplate)
void	copyAllAssessments(String fromContext, String toContext, Map<String,String> transversalMap)
void	copyAssessment(String assessmentId, String appendCopyTitle)
String	copyContentHostingAttachments(String text, String toContext)
Set	copyItemAttachmentSet(ItemData newItem, Set itemAttachmentSet)
static String	copyStringAttachment(String stringWithAttachment)
AssessmentFacade	createAssessment(String title, String description, String typeId, String templateId)
AssessmentFacade	createAssessment(String title, String description, String typeId, String templateId, String siteId)
AssessmentAttachmentIfc	createAssessmentAttachment(AssessmentIfc assessment, String resourceId, String filename, String protocol)
AssessmentFacade	createAssessmentWithoutDefaultSection(String title, String description, String typeId, String templateId)
AssessmentFacade	createAssessmentWithoutDefaultSection(String title, String description, String typeId, String templateId, String siteId)
ContentResource	createCopyOfContentResource(String resourceId, String filename)
ContentResource	createCopyOfContentResource(String resourceId, String filename, String toContext)
AttachmentData	createEmailAttachment(String resourceId, String filename, String protocol)
ItemAttachmentIfc	createItemAttachment(ItemDataIfc item, String resourceId, String filename, String protocol)
ItemAttachmentIfc	createItemAttachment(ItemDataIfc item, String resourceId, String filename, String protocol, boolean isEditPendingAssessmentFlow)
ItemTextAttachmentIfc	createItemTextAttachment(ItemTextIfc itemText, String resourceId, String filename, String protocol)
ItemTextAttachmentIfc	createItemTextAttachment(ItemTextIfc itemText, String resourceId, String filename, String protocol, boolean isEditPendingAssessmentFlow)
SectionAttachmentIfc	createSectionAttachment(SectionDataIfc section, String resourceId, String filename, String protocol)
void	deleteAllMetaData(AssessmentBaseIfc assessment)
void	deleteAllSecuredIP(AssessmentIfc assessment)
void	deleteAssessmentTemplate(Long assessmentId)
void	deleteResources(List resourceIdList)
static String	escapeResourceName(String id) Return a string based on id that is valid according to Resource name validity rules.
String	exportAssessmentToMarkupText(AssessmentFacade assessment, Map<String,String> bundle) Exports an assessment to mark up text
List<AssessmentFacade>	getAllActiveAssessments(String orderBy)
List	getAllActiveAssessmentsbyAgent(String fromContext)
List<AssessmentTemplateFacade>	getAllActiveAssessmentTemplates()
List<AssessmentFacade>	getAllAssessments(int pageSize, int pageNumber, String orderBy)
List<AssessmentFacade>	getAllAssessments(String orderBy)
List<AssessmentTemplateFacade>	getAllAssessmentTemplates()
AssessmentIfc	getAssessment(Long assessmentId)
AssessmentFacade	getAssessment(String assessmentId)
List	getAssessmentByTemplate(String templateId)
String	getAssessmentCreatedBy(String assessmentId)
List	getAssessmentResourceIdList(AssessmentIfc pub)
String	getAssessmentSiteId(String assessmentId) Get the siteid for the given assesment
AssessmentTemplateFacade	getAssessmentTemplate(String assessmentTemplateId)
List<AssessmentFacade>	getBasicInfoOfAllActiveAssessments(String orderBy)
List<AssessmentFacade>	getBasicInfoOfAllActiveAssessments(String orderBy, boolean ascending)
List<AssessmentTemplateFacade>	getBasicInfoOfAllActiveAssessmentTemplates(String orderBy)
AssessmentFacade	getBasicInfoOfAnAssessment(String assessmentId)
AssessmentFacade	getBasicInfoOfAnAssessmentFromSectionId(Long sectionId)
static ContentHostingService	getContentHostingService()
List	getDefaultMetaDataSet()
List<AssessmentData>	getDeletedAssessments(String siteId)
List	getFavoriteColChoicesbyAgent(String fromContext)
List	getItemResourceIdList(ItemDataIfc item)
List	getQuestionsIdList(long assessmentId)
int	getQuestionSize(String assessmentId)
SectionFacade	getSection(String sectionId)
List	getSectionResourceIdList(SectionDataIfc section)
List<AssessmentFacade>	getSettingsOfAllActiveAssessments(String orderBy)
List<AssessmentTemplateFacade>	getTitleOfAllActiveAssessmentTemplates()
boolean	isExportable(AssessmentFacade assessment) Check if there are questions not exportable to markup text
boolean	isQuestionTypeExportable2MarkupText(Long itemTypeId) Return true if the item can be exportable to mark up text
void	moveAllItems(String sourceSectionId, String destSectionId)
void	removeAllItems(String sourceSectionId)
void	removeAssessment(String assessmentId)
void	removeAssessmentAttachment(String attachmentId)
void	removeSection(String sectionId)
void	removeSectionAttachment(String attachmentId)
static String	renameDuplicate(String title) Append " - 2", " - 3", etc. incrementing as you go.
void	restoreAssessment(Long assessmentId)
void	save(AssessmentTemplateData template)
void	saveAssessment(AssessmentFacade assessment)
void	saveOrUpdateAttachments(List list)
void	saveOrUpdateSection(SectionFacade section)
void	update(AssessmentFacade assessment)
int	updateAllRandomPoolQuestions(AssessmentFacade assessment)
int	updateAllRandomPoolQuestions(AssessmentFacade assessment, boolean publishing)
void	updateAssessmentLastModifiedInfo(AssessmentIfc assessment)
int	updateRandomPoolQuestions(SectionFacade section)
int	updateRandomPoolQuestions(SectionFacade section, boolean publishing)
boolean	verifyItemsDrawSize(SectionFacade section)

Methods inherited from class java.lang.Object

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

Field Detail

UPDATE_SUCCESS

public static final int UPDATE_SUCCESS

See Also:

Constant Field Values

UPDATE_ERROR_DRAW_SIZE_TOO_LARGE

public static final int UPDATE_ERROR_DRAW_SIZE_TOO_LARGE

See Also:

Constant Field Values

INVALID_CHARS_IN_RESOURCE_ID

public static final String INVALID_CHARS_IN_RESOURCE_ID

These characters are not allowed in a resource id

See Also:

Constant Field Values

MAP_TO_A

protected static final String MAP_TO_A

See Also:

Constant Field Values

MAP_TO_B

protected static final String MAP_TO_B

See Also:

Constant Field Values

MAP_TO_C

protected static final String MAP_TO_C

See Also:

Constant Field Values

MAP_TO_E

protected static final String MAP_TO_E

See Also:

Constant Field Values

MAP_TO_I

protected static final String MAP_TO_I

See Also:

Constant Field Values

MAP_TO_L

protected static final String MAP_TO_L

See Also:

Constant Field Values

MAP_TO_N

protected static final String MAP_TO_N

See Also:

Constant Field Values

MAP_TO_O

protected static final String MAP_TO_O

See Also:

Constant Field Values

MAP_TO_U

protected static final String MAP_TO_U

See Also:

Constant Field Values

MAP_TO_Y

protected static final String MAP_TO_Y

See Also:

Constant Field Values

MAP_TO_X

protected static final String MAP_TO_X

See Also:

Constant Field Values

ESCAPE_CHARS_IN_RESOURCE_ID

protected static final String ESCAPE_CHARS_IN_RESOURCE_ID

These characters are allowed; but if escapeResourceName() is called, they are escaped (actually, removed) Certain characters cause problems with filenames in certain OSes - so get rid of these characters in filenames

See Also:

Constant Field Values

Constructor Detail

AssessmentService

public AssessmentService()

Creates a new QuestionPoolService object.

Method Detail

getAssessmentTemplate

public AssessmentTemplateFacade getAssessmentTemplate(String assessmentTemplateId)

getAssessment

public AssessmentFacade getAssessment(String assessmentId)

getAssessment

public AssessmentIfc getAssessment(Long assessmentId)

getBasicInfoOfAnAssessment

public AssessmentFacade getBasicInfoOfAnAssessment(String assessmentId)

getBasicInfoOfAnAssessmentFromSectionId

public AssessmentFacade getBasicInfoOfAnAssessmentFromSectionId(Long sectionId)

getAllAssessmentTemplates

public List<AssessmentTemplateFacade> getAllAssessmentTemplates()

getAllActiveAssessmentTemplates

public List<AssessmentTemplateFacade> getAllActiveAssessmentTemplates()

getTitleOfAllActiveAssessmentTemplates

public List<AssessmentTemplateFacade> getTitleOfAllActiveAssessmentTemplates()

getAllAssessments

public List<AssessmentFacade> getAllAssessments(String orderBy)

getAllActiveAssessments

public List<AssessmentFacade> getAllActiveAssessments(String orderBy)

getSettingsOfAllActiveAssessments

public List<AssessmentFacade> getSettingsOfAllActiveAssessments(String orderBy)

Parameters:

orderBy -

Returns:

an ArrayList of AssessmentFacade. It is IMPORTANT to note that the object is a partial object which contains no SectionFacade

getBasicInfoOfAllActiveAssessments

public List<AssessmentFacade> getBasicInfoOfAllActiveAssessments(String orderBy,
                                                                 boolean ascending)

Parameters:

orderBy -

Returns:

an ArrayList of AssessmentFacade. It is IMPORTANT to note that the object is a partial object which contains only Assessment basic info such as title, lastModifiedDate. This method is used by Authoring Front Door

getBasicInfoOfAllActiveAssessments

public List<AssessmentFacade> getBasicInfoOfAllActiveAssessments(String orderBy)

getAllAssessments

public List<AssessmentFacade> getAllAssessments(int pageSize,
                                                int pageNumber,
                                                String orderBy)

createAssessment

public AssessmentFacade createAssessment(String title,
                                         String description,
                                         String typeId,
                                         String templateId)
                                  throws Exception

Throws:

Exception

createAssessment

public AssessmentFacade createAssessment(String title,
                                         String description,
                                         String typeId,
                                         String templateId,
                                         String siteId)
                                  throws Exception

Throws:

Exception

getQuestionSize

public int getQuestionSize(String assessmentId)

getQuestionsIdList

public List getQuestionsIdList(long assessmentId)

update

public void update(AssessmentFacade assessment)

save

public void save(AssessmentTemplateData template)

deleteAllSecuredIP

public void deleteAllSecuredIP(AssessmentIfc assessment)

saveAssessment

public void saveAssessment(AssessmentFacade assessment)

deleteAssessmentTemplate

public void deleteAssessmentTemplate(Long assessmentId)

removeAssessment

public void removeAssessment(String assessmentId)

addSection

public SectionFacade addSection(String assessmentId)

public int checkDelete(long assessmentId){ return assessmentService.checkDelete(assessmentId); } public void deleteAssessment(Id assessmentId) throws osid.assessment.AssessmentException { assessmentService.deleteAssessment(assessmentId); } public AssessmentIterator getAssessments() throws osid.assessment.AssessmentException { return assessmentService.getAssessments(); }

removeSection

public void removeSection(String sectionId)

getSection

public SectionFacade getSection(String sectionId)

saveOrUpdateSection

public void saveOrUpdateSection(SectionFacade section)

moveAllItems

public void moveAllItems(String sourceSectionId,
                         String destSectionId)

removeAllItems

public void removeAllItems(String sourceSectionId)

verifyItemsDrawSize

public boolean verifyItemsDrawSize(SectionFacade section)

updateRandomPoolQuestions

public int updateRandomPoolQuestions(SectionFacade section)

updateRandomPoolQuestions

public int updateRandomPoolQuestions(SectionFacade section,
                                     boolean publishing)

updateAllRandomPoolQuestions

public int updateAllRandomPoolQuestions(AssessmentFacade assessment)

updateAllRandomPoolQuestions

public int updateAllRandomPoolQuestions(AssessmentFacade assessment,
                                        boolean publishing)

getBasicInfoOfAllActiveAssessmentTemplates

public List<AssessmentTemplateFacade> getBasicInfoOfAllActiveAssessmentTemplates(String orderBy)

createAssessmentWithoutDefaultSection

public AssessmentFacade createAssessmentWithoutDefaultSection(String title,
                                                              String description,
                                                              String typeId,
                                                              String templateId)
                                                       throws Exception

Throws:

Exception

createAssessmentWithoutDefaultSection

public AssessmentFacade createAssessmentWithoutDefaultSection(String title,
                                                              String description,
                                                              String typeId,
                                                              String templateId,
                                                              String siteId)
                                                       throws Exception

Throws:

Exception

assessmentTitleIsUnique

public boolean assessmentTitleIsUnique(String assessmentBaseId,
                                       String title,
                                       boolean isTemplate)

getAssessmentByTemplate

public List getAssessmentByTemplate(String templateId)

getDefaultMetaDataSet

public List getDefaultMetaDataSet()

deleteAllMetaData

public void deleteAllMetaData(AssessmentBaseIfc assessment)

createItemAttachment

public ItemAttachmentIfc createItemAttachment(ItemDataIfc item,
                                              String resourceId,
                                              String filename,
                                              String protocol)

createItemAttachment

public ItemAttachmentIfc createItemAttachment(ItemDataIfc item,
                                              String resourceId,
                                              String filename,
                                              String protocol,
                                              boolean isEditPendingAssessmentFlow)

createItemTextAttachment

public ItemTextAttachmentIfc createItemTextAttachment(ItemTextIfc itemText,
                                                      String resourceId,
                                                      String filename,
                                                      String protocol)

createItemTextAttachment

public ItemTextAttachmentIfc createItemTextAttachment(ItemTextIfc itemText,
                                                      String resourceId,
                                                      String filename,
                                                      String protocol,
                                                      boolean isEditPendingAssessmentFlow)

updateAssessmentLastModifiedInfo

public void updateAssessmentLastModifiedInfo(AssessmentIfc assessment)

createSectionAttachment

public SectionAttachmentIfc createSectionAttachment(SectionDataIfc section,
                                                    String resourceId,
                                                    String filename,
                                                    String protocol)

removeSectionAttachment

public void removeSectionAttachment(String attachmentId)

createAssessmentAttachment

public AssessmentAttachmentIfc createAssessmentAttachment(AssessmentIfc assessment,
                                                          String resourceId,
                                                          String filename,
                                                          String protocol)

removeAssessmentAttachment

public void removeAssessmentAttachment(String attachmentId)

createEmailAttachment

public AttachmentData createEmailAttachment(String resourceId,
                                            String filename,
                                            String protocol)

getAssessmentResourceIdList

public List getAssessmentResourceIdList(AssessmentIfc pub)

getSectionResourceIdList

public List getSectionResourceIdList(SectionDataIfc section)

getItemResourceIdList

public List getItemResourceIdList(ItemDataIfc item)

deleteResources

public void deleteResources(List resourceIdList)

saveOrUpdateAttachments

public void saveOrUpdateAttachments(List list)

createCopyOfContentResource

public ContentResource createCopyOfContentResource(String resourceId,
                                                   String filename,
                                                   String toContext)

createCopyOfContentResource

public ContentResource createCopyOfContentResource(String resourceId,
                                                   String filename)

escapeResourceName

public static String escapeResourceName(String id)

Return a string based on id that is valid according to Resource name validity rules.

Parameters:

id - The string to escape.

Returns:

id fully escaped using Resource name validity rules.

copyAllAssessments

public void copyAllAssessments(String fromContext,
                               String toContext,
                               Map<String,String> transversalMap)

copyAssessment

public void copyAssessment(String assessmentId,
                           String appendCopyTitle)

getAllActiveAssessmentsbyAgent

public List getAllActiveAssessmentsbyAgent(String fromContext)

getAssessmentSiteId

public String getAssessmentSiteId(String assessmentId)

Get the siteid for the given assesment

Parameters:

assessmentId -

Returns:

getAssessmentCreatedBy

public String getAssessmentCreatedBy(String assessmentId)

copyItemAttachmentSet

public Set copyItemAttachmentSet(ItemData newItem,
                                 Set itemAttachmentSet)

getContentHostingService

public static ContentHostingService getContentHostingService()

getFavoriteColChoicesbyAgent

public List getFavoriteColChoicesbyAgent(String fromContext)

copyContentHostingAttachments

public String copyContentHostingAttachments(String text,
                                            String toContext)

exportAssessmentToMarkupText

public String exportAssessmentToMarkupText(AssessmentFacade assessment,
                                           Map<String,String> bundle)

Exports an assessment to mark up text

Parameters:

assessment -

bundle -

Returns:

isExportable

public boolean isExportable(AssessmentFacade assessment)

Check if there are questions not exportable to markup text

Parameters:

assessment -

Returns:

isQuestionTypeExportable2MarkupText

public boolean isQuestionTypeExportable2MarkupText(Long itemTypeId)

Return true if the item can be exportable to mark up text

Parameters:

itemTypeId -

Returns:

copyStringAttachment

public static String copyStringAttachment(String stringWithAttachment)

getDeletedAssessments

public List<AssessmentData> getDeletedAssessments(String siteId)

restoreAssessment

public void restoreAssessment(Long assessmentId)

renameDuplicate

public static String renameDuplicate(String title)

Append " - 2", " - 3", etc. incrementing as you go.

Parameters:

original - title

Returns:

title with versioning