A C D G I O P Q R S T U W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- allowAllContent() - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Each content review implementation can either accept all files or reject unsupported file formats.
- allowResubmission() - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Does the service support resubmissions?
- allowSubmissionsOnBehalf() - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Flag to determine whether the service accepts submissions on behalf of users
C
- checkForReports() - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Check for reports for all submitted items that don't have reports yet
- CONTENT_REVIEW_NOT_SUBMITTED - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_NOT_SUBMITTED_CODE - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_REPORT_ERROR_NO_RETRY - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_REPORT_ERROR_NO_RETRY_CODE - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_REPORT_ERROR_RETRY - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_REPORT_ERROR_RETRY_CODE - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_SUBMISSION_ERROR_NO_RETRY - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_SUBMISSION_ERROR_NO_RETRY_CODE - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_SUBMISSION_ERROR_RETRY - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_SUBMISSION_ERROR_RETRY_CODE - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_SUBMISSION_ERROR_RETRY_EXCEEDED - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_SUBMISSION_ERROR_RETRY_EXCEEDED_CODE - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_SUBMISSION_ERROR_USER_DETAILS - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_SUBMISSION_ERROR_USER_DETAILS_CODE - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_SUBMITTED_AWAITING_REPORT - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_SUBMITTED_AWAITING_REPORT_CODE - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_SUBMITTED_REPORT_AVAILABLE - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- CONTENT_REVIEW_SUBMITTED_REPORT_AVAILABLE_CODE - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- ContentReviewConstants - Class in org.sakaiproject.contentreview.dao
- ContentReviewConstants() - Constructor for class org.sakaiproject.contentreview.dao.ContentReviewConstants
- ContentReviewItem - Class in org.sakaiproject.contentreview.dao
-
This is a POJO (data storage object)
- ContentReviewItem(String, Integer) - Constructor for class org.sakaiproject.contentreview.dao.ContentReviewItem
- ContentReviewItem(String, String, String, String, Date, Long, Integer) - Constructor for class org.sakaiproject.contentreview.dao.ContentReviewItem
- ContentReviewProviderException - Exception in org.sakaiproject.contentreview.exception
- ContentReviewProviderException() - Constructor for exception org.sakaiproject.contentreview.exception.ContentReviewProviderException
- ContentReviewProviderException(String) - Constructor for exception org.sakaiproject.contentreview.exception.ContentReviewProviderException
- ContentReviewProviderException(String, String) - Constructor for exception org.sakaiproject.contentreview.exception.ContentReviewProviderException
- ContentReviewProviderException(String, String, Throwable) - Constructor for exception org.sakaiproject.contentreview.exception.ContentReviewProviderException
- ContentReviewProviderException(String, Throwable) - Constructor for exception org.sakaiproject.contentreview.exception.ContentReviewProviderException
- ContentReviewProviderException(String, Throwable, boolean, boolean) - Constructor for exception org.sakaiproject.contentreview.exception.ContentReviewProviderException
- ContentReviewProviderException(Throwable) - Constructor for exception org.sakaiproject.contentreview.exception.ContentReviewProviderException
- ContentReviewQueueService - Interface in org.sakaiproject.contentreview.service
- ContentReviewService - Interface in org.sakaiproject.contentreview.service
-
ContentReview Service manages submission to the Content review queue and retrieving reports from the service
- ContentReviewSiteAdvisor - Interface in org.sakaiproject.contentreview.advisors
- createAssignment(String, String, Map) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
This is a vendor specific method needed for some deep integrations (such as A2) to pre provision assignments on an external content checking system.
D
- delete(ContentReviewItem) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Deprecated.
- deleteAssignment(String, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
For the given taskId, does any necessary cleanup when an assignment is hard deleted
G
- getAcceptableExtensionsToMimeTypes() - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Gets a map of acceptable file extensions for this content-review service to their associated mime types (ie. ".rtf" -> ["text/rtf", "application,rtf"])
- getAcceptableFileTypesToExtensions() - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Gets a map of acceptable file types for this content-review service (as UI presentable names) to their associated file extensions (ie.
- getAllContentReviewItems(String, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
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.
- getAllContentReviewItemsGroupedBySiteAndTask(Integer) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Gets all items grouped by site and task
- getAssignment(String, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
This is a vendor specific method to allow getting information about a particular assignment in an external plagiarism checking system.
- getAwaitingReports(Integer) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Get items awaiting a report from the content review service
- getContentReviewItemByContentId(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
This method returns all the information related with a ContentReviewItem encapsulated as a ContentReviewResult Using this method will likely tie you to a particular Content Review implementation.
- getContentReviewItems(Integer, String, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Get the items for a site or a task.
- getContentReviewItemsGroupedBySite(Integer) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Gets all items grouped by site, order by most recent items descending
- getDateQueued(Integer, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Deprecated.Use getQueuedItem method to get ContentReviewItem object
- getDateQueued(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
The date an item was queued
- getDateSubmitted(Integer, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Deprecated.Use getQueuedItem method to get ContentReviewItem object
- getDateSubmitted(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
The date an item was submitted to the queue
- getEndUserLicenseAgreementLink(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Returns a hyperlink to a providers EULA, if empty, no EULA will be shown to the user
- getEndUserLicenseAgreementTimestamp() - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Returns date for most recent EULA.
- getEndUserLicenseAgreementVersion() - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Returns version for most recent EULA.
- getErrorCode() - Method in exception org.sakaiproject.contentreview.exception.SubmissionException
- getErrorCode() - Method in exception org.sakaiproject.contentreview.exception.TransientSubmissionException
- getI18nXml() - Method in exception org.sakaiproject.contentreview.exception.ContentReviewProviderException
-
Returns the an xml representation of formatted messages if i18nXml is set; otherwise fallsback to getLocalizedMessage()
- getIconCssClassforScore(int, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Get a icon URL that for a specific score
- getLocalizedLastError(ContentReviewItem) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Gets the ContentReviewItem's last error localized for the current user session
- getLocalizedStatusMessage(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Get a status message for a submission in the locale of the current user
- getLocalizedStatusMessage(String, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Get a status message for a submission in the locale of the specified user
- getLocalizedStatusMessage(String, Locale) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Get a status message for a submission in the locale specified
- getNextItemInQueueToSubmit(Integer) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Get the next item in the queue to be submitted to the content review service
- getProviderId() - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Provides a default implementation for uniquely identifying a provider
- getQueuedItem(Integer, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Get an item that has been queued and contentId.
- getQueuedItemByExternalId(Integer, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Get an item that has been queued via external ID.
- getQueuedNotSubmittedItems(Integer) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Get items queued but have not yet been submitted to the content review service
- getReportList(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Get a list of reports for all tasks in a site
- getReportList(String, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Get a list of reports for a task
- getReviewError(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Deprecated.
- getReviewReport(String, String, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Get the URL of the report
- getReviewReportInstructor(String, String, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Get the URL for a report constructed for an Instructor
- getReviewReportRedirectUrl(String, String, String, String, boolean) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Option for providers to decide whether they want to use redirect logic for the report URLs.
- getReviewReportStudent(String, String, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Get the URL of a report constructed for a student
- getReviewScore(Integer, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Deprecated.Use getQueuedItem method to get ContentReviewItem object
- getReviewScore(String, String, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Retrieve a score for a item
- getReviewStatus(Integer, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Deprecated.Use getQueuedItem method to get ContentReviewItem object
- getReviewStatus(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Get the status of a submission
- getServiceName() - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Return the Name of the Service Implementation for Display Purposes
- getUserEULATimestamp(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Returns date for the user's last agreement to the EULA.
- getUserEULAVersion(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Returns version for the user's last agreement to the EULA.
I
- isAcceptableContent(ContentResource) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Is the content resource of a type that can be accepted by the service implementation
- isSiteAcceptable(Site) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Can this site make use of the content review service
O
- org.sakaiproject.contentreview.advisors - package org.sakaiproject.contentreview.advisors
- org.sakaiproject.contentreview.dao - package org.sakaiproject.contentreview.dao
- org.sakaiproject.contentreview.exception - package org.sakaiproject.contentreview.exception
- org.sakaiproject.contentreview.service - package org.sakaiproject.contentreview.service
P
- processQueue() - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Proccess all pending jobs in the Queue
Q
- queueContent(Integer, String, String, String, List<ContentResource>) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Queue a content item that will later be sent to the content review service when the Content Review Process Job is run.
- queueContent(String, String, String, List<ContentResource>) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Add an item to the Queue for Submission to Turnitin
- QueueException - Exception in org.sakaiproject.contentreview.exception
- QueueException() - Constructor for exception org.sakaiproject.contentreview.exception.QueueException
- QueueException(String) - Constructor for exception org.sakaiproject.contentreview.exception.QueueException
- QueueException(String, Throwable) - Constructor for exception org.sakaiproject.contentreview.exception.QueueException
- QueueException(Throwable) - Constructor for exception org.sakaiproject.contentreview.exception.QueueException
R
- removeFromQueue(Integer, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Remove an item from queue
- removeFromQueue(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Remove an item from the review Queue
- ReportException - Exception in org.sakaiproject.contentreview.exception
- ReportException() - Constructor for exception org.sakaiproject.contentreview.exception.ReportException
- ReportException(String) - Constructor for exception org.sakaiproject.contentreview.exception.ReportException
- ReportException(String, Throwable) - Constructor for exception org.sakaiproject.contentreview.exception.ReportException
- ReportException(Throwable) - Constructor for exception org.sakaiproject.contentreview.exception.ReportException
- resetUserDetailsLockedItems(Integer, String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Sets the items to be retried for a specific user and a status of
ContentReviewConstants - resetUserDetailsLockedItems(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Reset the Items for a specific user that where locked because of incomplete user details
S
- setErrorCode(Integer) - Method in exception org.sakaiproject.contentreview.exception.SubmissionException
- setErrorCode(Integer) - Method in exception org.sakaiproject.contentreview.exception.TransientSubmissionException
- siteCanUseReviewService(Site) - Method in interface org.sakaiproject.contentreview.advisors.ContentReviewSiteAdvisor
- SubmissionException - Exception in org.sakaiproject.contentreview.exception
- SubmissionException() - Constructor for exception org.sakaiproject.contentreview.exception.SubmissionException
- SubmissionException(String) - Constructor for exception org.sakaiproject.contentreview.exception.SubmissionException
- SubmissionException(String, Integer) - Constructor for exception org.sakaiproject.contentreview.exception.SubmissionException
- SubmissionException(String, Throwable) - Constructor for exception org.sakaiproject.contentreview.exception.SubmissionException
- SubmissionException(Throwable) - Constructor for exception org.sakaiproject.contentreview.exception.SubmissionException
- syncRosters() - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Sync roster information with services that depend on membership information.
T
- TransientSubmissionException - Exception in org.sakaiproject.contentreview.exception
- TransientSubmissionException() - Constructor for exception org.sakaiproject.contentreview.exception.TransientSubmissionException
- TransientSubmissionException(String) - Constructor for exception org.sakaiproject.contentreview.exception.TransientSubmissionException
- TransientSubmissionException(String, Integer) - Constructor for exception org.sakaiproject.contentreview.exception.TransientSubmissionException
- TransientSubmissionException(String, Throwable) - Constructor for exception org.sakaiproject.contentreview.exception.TransientSubmissionException
- TransientSubmissionException(Throwable) - Constructor for exception org.sakaiproject.contentreview.exception.TransientSubmissionException
- TURNITIN_PROVIDER_ID - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- TURNITINOC_PROVIDER_ID - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
U
- update(ContentReviewItem) - Method in interface org.sakaiproject.contentreview.service.ContentReviewQueueService
-
Deprecated.
- updateUserEULATimestamp(String) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Sets date for the user's last agreement to the EULA to current date
- URKUND_OPTOUT_URL - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
- URKUND_REPORT_URL - Static variable in class org.sakaiproject.contentreview.dao.ContentReviewConstants
W
- webhookEvent(HttpServletRequest, int, Optional<String>) - Method in interface org.sakaiproject.contentreview.service.ContentReviewService
-
Webhook event listener that can be used to get messages sent from the provider to Sakai
All Classes All Packages