org.dataconservancy.pass.client.util

Class SubmissionStatusCalculator

java.lang.Object

org.dataconservancy.pass.client.util.SubmissionStatusCalculator

public class SubmissionStatusCalculator
extends Object

A utility to calculate and validate the Submission Status. Separate calculations are provided depending on whether the Submission has been submitted or not since different data and rules apply

Author:

Karen Hanson

Constructor Summary

Constructors

Constructor and Description
SubmissionStatusCalculator()

Method Summary

Modifier and Type	Method and Description
static org.dataconservancy.pass.model.Submission.SubmissionStatus	calculatePostSubmissionStatus(List<URI> repositories, List<org.dataconservancy.pass.model.Deposit> deposits, List<org.dataconservancy.pass.model.RepositoryCopy> repositoryCopies) Calculates the appropriate post-Submission status based on data provided.
static org.dataconservancy.pass.model.Submission.SubmissionStatus	calculatePreSubmissionStatus(List<org.dataconservancy.pass.model.SubmissionEvent> submissionEvents, org.dataconservancy.pass.model.Submission.SubmissionStatus defaultStatus) Calculates the appropriate pre-Submission status based on data provided.
static void	validateStatusChange(boolean submitted, org.dataconservancy.pass.model.Submission.SubmissionStatus fromStatus, org.dataconservancy.pass.model.Submission.SubmissionStatus toStatus) Checks validity of Submission.SubmissionStatus change, will throw exception or output a warning if there are any validation issue with the change

Methods inherited from class java.lang.Object

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

Constructor Detail

SubmissionStatusCalculator

public SubmissionStatusCalculator()

Method Detail

calculatePostSubmissionStatus

public static org.dataconservancy.pass.model.Submission.SubmissionStatus calculatePostSubmissionStatus(List<URI> repositories,
                                                                                                       List<org.dataconservancy.pass.model.Deposit> deposits,
                                                                                                       List<org.dataconservancy.pass.model.RepositoryCopy> repositoryCopies)

Calculates the appropriate post-Submission status based on data provided.

Post-Submission calculations uses the Deposits and RepositoryCopies associated with a Submission's Repositories to determine the status of a Submission after it has been submitted (Submission.status=true.

Parameters:

repositories - Submission repositories

deposits - Submission deposits

repositoryCopies - Submission repository copies

Returns:

Calculated submission status

calculatePreSubmissionStatus

public static org.dataconservancy.pass.model.Submission.SubmissionStatus calculatePreSubmissionStatus(List<org.dataconservancy.pass.model.SubmissionEvent> submissionEvents,
                                                                                                      org.dataconservancy.pass.model.Submission.SubmissionStatus defaultStatus)

Calculates the appropriate pre-Submission status based on data provided.

Pre-Submission calculations use the SubmissionEvents associated with the Submission to determine the status of a Submission before it has been submitted (Submission.submitted=false).

If a default status is provided, it will be returned only if a status cannot be determined from the submission events. If no default status is provided, and a status cannot be determined from the submission events, then this method returns MANUSCRIPT_REQUIRED in order to maintain backwards compatibility.

Parameters:

submissionEvents - List of submission events

defaultStatus - the the status to be returned if no status can be determined from the submission events, may be null

Returns:

calculated submission status, or the default status if one cannot be calculated from the events

validateStatusChange

public static void validateStatusChange(boolean submitted,
                                        org.dataconservancy.pass.model.Submission.SubmissionStatus fromStatus,
                                        org.dataconservancy.pass.model.Submission.SubmissionStatus toStatus)

Checks validity of Submission.SubmissionStatus change, will throw exception or output a warning if there are any validation issue with the change

Parameters:

submitted - Whether the submission is submitted

fromStatus - Original status

toStatus - Desired new status