public interface ContentReviewService
| Modifier and Type | Method and Description |
|---|---|
boolean |
allowResubmission()
Does the service support resubmissions?
|
void |
checkForReports()
Check for reports for all submitted items that don't have reports yet
|
void |
createAssignment(String siteId,
String taskId,
Map extraAsnnOpts)
This is a vendor specific method needed for some deep integrations
(such as A2) to pre provision assignments on an external content
checking system.
|
List<org.sakaiproject.contentreview.model.ContentReviewItem> |
getAllContentReviewItems(String siteId,
String taskId)
This is a complement to getReportList, except that it returns all
ContentReviewItems for a site and task, rather than just the ones
whose reports have been completed.
|
Map |
getAssignment(String siteId,
String taskId)
This is a vendor specific method to allow getting information about
a particular assignment in an external plagiarism checking system.
|
Date |
getDateQueued(String contextId)
The date an item was queued
|
Date |
getDateSubmitted(String contextId)
The date an item was submitted to the queue
|
String |
getIconUrlforScore(Long score)
Get a icon URL that for a specific score
|
String |
getLocalizedStatusMessage(String messageCode)
Get a status message for a submission in the locale of the current user
|
String |
getLocalizedStatusMessage(String messageCode,
Locale locale)
Get a status message for a submission in the locale specified
|
String |
getLocalizedStatusMessage(String messageCode,
String userRef)
Get a status message for a submission in the locale of the specified user
|
List<org.sakaiproject.contentreview.model.ContentReviewItem> |
getReportList(String siteId)
Get a list of reports for all tasks in a site
|
List<org.sakaiproject.contentreview.model.ContentReviewItem> |
getReportList(String siteId,
String taskId)
Get a list of reports for a task
|
String |
getReviewError(String contentId)
Deprecated.
|
String |
getReviewReport(String contentId)
Get the URL of the report
|
String |
getReviewReportInstructor(String contentId)
Get the URL for a report constructed for an Instructor
|
String |
getReviewReportStudent(String contentId)
Get the URL of a report constructed for a student
|
int |
getReviewScore(String contentId)
Retrieve a score for a specific item
|
Long |
getReviewStatus(String contentId)
Get the status of a submission
|
String |
getServiceName()
Return the Name of the Service Implementation for Display Purposes
|
boolean |
isAcceptableContent(org.sakaiproject.content.api.ContentResource resource)
Is the content resource of an type that can be accepted by the service implementation
|
boolean |
isSiteAcceptable(org.sakaiproject.site.api.Site site)
Can this site make use of the content review service
|
void |
processQueue()
Proccess all pending jobs in the Queue
|
void |
queueContent(String userId,
String siteId,
String taskId,
String contentId)
Add an item to the Queue for Submission to Turnitin
|
void |
removeFromQueue(String ContentId)
Remove an item from the review Queue
|
void |
resetUserDetailsLockedItems(String userId)
Reset the Items for a specific user that where locked because of incomplete user details
|
void queueContent(String userId, String siteId, String taskId, String contentId) throws org.sakaiproject.contentreview.exception.QueueException
userID - if nulll current user is usedSiteId - is null current site is usedEntity - reference to the task this is forReference - to the content object that should be submittedorg.sakaiproject.contentreview.exception.QueueExceptionint getReviewScore(String contentId) throws org.sakaiproject.contentreview.exception.QueueException, org.sakaiproject.contentreview.exception.ReportException, Exception
contentId - org.sakaiproject.contentreview.exception.QueueExceptionorg.sakaiproject.contentreview.exception.ReportExceptionExceptionString getReviewReport(String contentId) throws org.sakaiproject.contentreview.exception.QueueException, org.sakaiproject.contentreview.exception.ReportException
contentId - org.sakaiproject.contentreview.exception.QueueExceptionorg.sakaiproject.contentreview.exception.ReportException - * * @deprecated since Nov 2007, use getReviewReportInstructor(String contentId) or getReviewReportInstructor(String contentId)String getReviewReportStudent(String contentId) throws org.sakaiproject.contentreview.exception.QueueException, org.sakaiproject.contentreview.exception.ReportException
contentId - org.sakaiproject.contentreview.exception.QueueExceptionorg.sakaiproject.contentreview.exception.ReportExceptionString getReviewReportInstructor(String contentId) throws org.sakaiproject.contentreview.exception.QueueException, org.sakaiproject.contentreview.exception.ReportException
contentId - org.sakaiproject.contentreview.exception.QueueExceptionorg.sakaiproject.contentreview.exception.ReportExceptionLong getReviewStatus(String contentId) throws org.sakaiproject.contentreview.exception.QueueException
contentId - org.sakaiproject.contentreview.exception.QueueExceptionDate getDateQueued(String contextId) throws org.sakaiproject.contentreview.exception.QueueException
contextId - org.sakaiproject.contentreview.exception.QueueExceptionDate getDateSubmitted(String contextId) throws org.sakaiproject.contentreview.exception.QueueException, org.sakaiproject.contentreview.exception.SubmissionException
contextId - org.sakaiproject.contentreview.exception.QueueExceptionorg.sakaiproject.contentreview.exception.SubmissionExceptionvoid processQueue()
void checkForReports()
List<org.sakaiproject.contentreview.model.ContentReviewItem> getReportList(String siteId, String taskId) throws org.sakaiproject.contentreview.exception.QueueException, org.sakaiproject.contentreview.exception.SubmissionException, org.sakaiproject.contentreview.exception.ReportException
siteId - taskId - org.sakaiproject.contentreview.exception.QueueExceptionorg.sakaiproject.contentreview.exception.SubmissionExceptionorg.sakaiproject.contentreview.exception.ReportExceptionList<org.sakaiproject.contentreview.model.ContentReviewItem> getReportList(String siteId) throws org.sakaiproject.contentreview.exception.QueueException, org.sakaiproject.contentreview.exception.SubmissionException, org.sakaiproject.contentreview.exception.ReportException
siteId - org.sakaiproject.contentreview.exception.QueueExceptionorg.sakaiproject.contentreview.exception.SubmissionExceptionorg.sakaiproject.contentreview.exception.ReportExceptionList<org.sakaiproject.contentreview.model.ContentReviewItem> getAllContentReviewItems(String siteId, String taskId) throws org.sakaiproject.contentreview.exception.QueueException, org.sakaiproject.contentreview.exception.SubmissionException, org.sakaiproject.contentreview.exception.ReportException
siteId - taskId - org.sakaiproject.contentreview.exception.QueueExceptionorg.sakaiproject.contentreview.exception.SubmissionExceptionorg.sakaiproject.contentreview.exception.ReportExceptionString getServiceName()
void resetUserDetailsLockedItems(String userId)
userId - boolean isAcceptableContent(org.sakaiproject.content.api.ContentResource resource)
resource - boolean isSiteAcceptable(org.sakaiproject.site.api.Site site)
site - String getIconUrlforScore(Long score)
score - boolean allowResubmission()
void removeFromQueue(String ContentId)
ContentId - String getLocalizedStatusMessage(String messageCode, String userRef)
messageCode - userRef - String getLocalizedStatusMessage(String messageCode)
messageCode - String getReviewError(String contentId)
getLocalizedStatusMessage(String)contentId - String getLocalizedStatusMessage(String messageCode, Locale locale)
messageCode - locale - Map getAssignment(String siteId, String taskId) throws org.sakaiproject.contentreview.exception.SubmissionException, org.sakaiproject.contentreview.exception.TransientSubmissionException
siteId - taskId - org.sakaiproject.contentreview.exception.SubmissionExceptionorg.sakaiproject.contentreview.exception.TransientSubmissionExceptionvoid createAssignment(String siteId, String taskId, Map extraAsnnOpts) throws org.sakaiproject.contentreview.exception.SubmissionException, org.sakaiproject.contentreview.exception.TransientSubmissionException
siteId - taskId - extraAsnnOpts - org.sakaiproject.contentreview.exception.SubmissionExceptionorg.sakaiproject.contentreview.exception.TransientSubmissionExceptionCopyright © 2003-2015 Sakai Project. All Rights Reserved.