Package org.sakaiproject.contentreview.service

Class BaseContentReviewService

java.lang.Object

org.sakaiproject.contentreview.service.BaseContentReviewService

All Implemented Interfaces:

ContentReviewService

Direct Known Subclasses:

ContentReviewFederatedServiceImpl, NoOpContentReviewService

public abstract class BaseContentReviewService
extends Object
implements ContentReviewService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BaseContentReviewService.LastErrorUpdater	Functional interface for updateLastError

Field Summary

Fields

Modifier and Type	Field	Description
protected AssignmentService	assignmentService
protected ContentReviewQueueService	crqs
protected EntityManager	entityManager
protected PreferencesService	preferencesService
protected ServerConfigurationService	serverConfigurationService

Constructor Summary

Constructors

Constructor	Description
BaseContentReviewService()

Method Summary

Modifier and Type	Method	Description
boolean	allowSubmissionsOnBehalf()
void	createAssignment(String contextId, String taskId, Map opts)
protected Object	createFormattedMessageXML(Document document, String key, Object... args)	Creates XML that represents calls to ResourceLoader.getFormattedMessage().
protected String	createLastError(BaseContentReviewService.LastErrorUpdater leu)	Create's an XML model that represents calls to ResourceLoader.getFormattedMessage(...).
protected void	deleteAllSubmissionsForAssignment(String siteId, String taskId)
void	deleteAssignment(String siteId, String taskId)
String	getLocalizedLastError(ContentReviewItem item)
protected ResourceLoader	getResourceLoader()	The Resource Loader specific to the content-review service implementation
protected String	getResourceLoaderName()	Gets the name of the resource loader's file.
String	getReviewReport(String contentId, String assignmentRef, String userId)
String	getReviewReportInstructor(String contentId, String assignmentRef, String userId)
String	getReviewReportRedirectUrl(String contentId, String assignmentRef, String userId, String contextId, boolean isInstructor)
String	getReviewReportStudent(String contentId, String assignmentRef, String userId)
Instant	getUserEULATimestamp(String userId)
String	getUserEULAVersion(String userId)
String	getWebhookUrl(Optional<String> customParam)
protected void	queueAllSubmissionsForAssignment(String taskId)
protected void	setLastError(ContentReviewItem item, Exception e)	Convenience method: If the Exception is an instance of ContentReviewProviderException, the item's lastError is set to the exception's I18nXml; otherwise it falls back to getLocalizedMessage()
protected void	setLastError(ContentReviewItem item, Exception e, BaseContentReviewService.LastErrorUpdater leu)	If the Exception is an instance of ContentReviewProviderException, the item's lastError is set to the exception's I18nXml; otherwise it falls back to leu; if leu is null, it falls back to getLocalizedMessage()
protected void	setLastError(ContentReviewItem item, BaseContentReviewService.LastErrorUpdater leu)	Sets the ContentReviewItem's lastError property to the result of createLastError(leu).
void	updateUserEULATimestamp(String userId)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sakaiproject.contentreview.service.ContentReviewService

allowAllContent, allowResubmission, checkForReports, getAcceptableExtensionsToMimeTypes, getAcceptableFileTypesToExtensions, getAllContentReviewItems, getAssignment, getContentReviewItemByContentId, getDateQueued, getDateSubmitted, getEndUserLicenseAgreementLink, getEndUserLicenseAgreementTimestamp, getEndUserLicenseAgreementVersion, getIconCssClassforScore, getLocalizedStatusMessage, getLocalizedStatusMessage, getLocalizedStatusMessage, getProviderId, getReportList, getReportList, getReviewError, getReviewScore, getReviewStatus, getServiceName, isAcceptableContent, isSiteAcceptable, processQueue, queueContent, removeFromQueue, resetUserDetailsLockedItems, syncRosters, webhookEvent

Field Detail

assignmentService

protected AssignmentService assignmentService

crqs

protected ContentReviewQueueService crqs

entityManager

protected EntityManager entityManager

preferencesService

protected PreferencesService preferencesService

serverConfigurationService

protected ServerConfigurationService serverConfigurationService

Constructor Detail

BaseContentReviewService

public BaseContentReviewService()

Method Detail

getUserEULATimestamp

public Instant getUserEULATimestamp(String userId)

Specified by:

getUserEULATimestamp in interface ContentReviewService

getUserEULAVersion

public String getUserEULAVersion(String userId)

Specified by:

getUserEULAVersion in interface ContentReviewService

updateUserEULATimestamp

public void updateUserEULATimestamp(String userId)

Specified by:

updateUserEULATimestamp in interface ContentReviewService

createAssignment

public void createAssignment(String contextId,
                             String taskId,
                             Map opts)
                      throws SubmissionException,
                             TransientSubmissionException

Specified by:

createAssignment in interface ContentReviewService

Throws:

SubmissionException

TransientSubmissionException

queueAllSubmissionsForAssignment

protected void queueAllSubmissionsForAssignment(String taskId)

deleteAssignment

public void deleteAssignment(String siteId,
                             String taskId)

Specified by:

deleteAssignment in interface ContentReviewService

deleteAllSubmissionsForAssignment

protected void deleteAllSubmissionsForAssignment(String siteId,
                                                 String taskId)

getReviewReport

public String getReviewReport(String contentId,
                              String assignmentRef,
                              String userId)
                       throws QueueException,
                              ReportException

Specified by:

getReviewReport in interface ContentReviewService

Throws:

QueueException

ReportException

getReviewReportInstructor

public String getReviewReportInstructor(String contentId,
                                        String assignmentRef,
                                        String userId)
                                 throws QueueException,
                                        ReportException

Specified by:

getReviewReportInstructor in interface ContentReviewService

Throws:

QueueException

ReportException

getReviewReportStudent

public String getReviewReportStudent(String contentId,
                                     String assignmentRef,
                                     String userId)
                              throws QueueException,
                                     ReportException

Specified by:

getReviewReportStudent in interface ContentReviewService

Throws:

QueueException

ReportException

getReviewReportRedirectUrl

public String getReviewReportRedirectUrl(String contentId,
                                         String assignmentRef,
                                         String userId,
                                         String contextId,
                                         boolean isInstructor)

Specified by:

getReviewReportRedirectUrl in interface ContentReviewService

getWebhookUrl

public String getWebhookUrl(Optional<String> customParam)

createFormattedMessageXML

protected Object createFormattedMessageXML(Document document,
                                           String key,
                                           Object... args)

Creates XML that represents calls to ResourceLoader.getFormattedMessage().

Returns:

an XML element representing the i18n message key and arguments - unless document is null, in which case the formatted message is returned as a String using the current session locale

setLastError

protected void setLastError(ContentReviewItem item,
                            BaseContentReviewService.LastErrorUpdater leu)

Sets the ContentReviewItem's lastError property to the result of createLastError(leu). Changes are not committed - the caller is responsible to do so. Afterward, the message can be localized to end users via getLocalizedLastError(item).

setLastError

protected void setLastError(ContentReviewItem item,
                            Exception e)

Convenience method: If the Exception is an instance of ContentReviewProviderException, the item's lastError is set to the exception's I18nXml; otherwise it falls back to getLocalizedMessage()

setLastError

protected void setLastError(ContentReviewItem item,
                            Exception e,
                            BaseContentReviewService.LastErrorUpdater leu)

If the Exception is an instance of ContentReviewProviderException, the item's lastError is set to the exception's I18nXml; otherwise it falls back to leu; if leu is null, it falls back to getLocalizedMessage()

createLastError

protected String createLastError(BaseContentReviewService.LastErrorUpdater leu)

Create's an XML model that represents calls to ResourceLoader.getFormattedMessage(...). Example - represent an i18n compliant message for "An error has occurred with the service. Error code: 42; cause: A Sakaiger ate the paper" given: service.error=An error has occurred with the service. Error code: {0}; cause: {1} service.sakaiger.ate.paper=A Sakaiger ate the paper You may invoke: createLastError(doc -> createFormattedMessageXML(doc, "service.error", 42, createFormattedMessageXML(doc, "service.sakaiger.ate.paper")));

getLocalizedLastError

public String getLocalizedLastError(ContentReviewItem item)

Specified by:

getLocalizedLastError in interface ContentReviewService

getResourceLoader

protected ResourceLoader getResourceLoader()

The Resource Loader specific to the content-review service implementation

getResourceLoaderName

protected String getResourceLoaderName()

Gets the name of the resource loader's file. Default implementation is getServiceName() to lower case, and this should be overriden as necessary

allowSubmissionsOnBehalf

public boolean allowSubmissionsOnBehalf()

Specified by:

allowSubmissionsOnBehalf in interface ContentReviewService