org.dataconservancy.pass.client

Class SubmissionStatusService

java.lang.Object

org.dataconservancy.pass.client.SubmissionStatusService

public class SubmissionStatusService
extends Object

A service for calculating and updating the `Submission.submissionStatus` value based on data related to the Submission. By default, there is a division of responsibility in calculating this status, with pre-submission statuses being managed by the UI, and post-Submission statuses being managed by back-end services. For this reason, pre-submission statuses will only be changed if the starting value is null, or overrideUIStatus is true.

Author:

Karen Hanson

Constructor Summary

Constructors

Constructor and Description
SubmissionStatusService(org.dataconservancy.pass.model.Submission submission) Initiate service using a Submission object
SubmissionStatusService(org.dataconservancy.pass.model.Submission submission, PassClient client) Supports setting a specific client, primarily for testing.
SubmissionStatusService(URI submissionId) Initiate service using a `Submission.id`

Method Summary

Modifier and Type	Method and Description
org.dataconservancy.pass.model.Submission.SubmissionStatus	calculateAndUpdateSubmissionStatus() Calculates the appropriate Submission.SubmissionStatus for the Submission provided.
org.dataconservancy.pass.model.Submission.SubmissionStatus	calculateAndUpdateSubmissionStatus(boolean overrideUIStatus) Calculates the appropriate Submission.SubmissionStatus for the Submission provided.
org.dataconservancy.pass.model.Submission.SubmissionStatus	calculateSubmissionStatus() Calculates the appropriate Submission.SubmissionStatus for the Submission provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubmissionStatusService

public SubmissionStatusService(org.dataconservancy.pass.model.Submission submission)

Initiate service using a Submission object

Parameters:

submission - The submission

SubmissionStatusService

public SubmissionStatusService(URI submissionId)

Initiate service using a `Submission.id`

Parameters:

submissionId - Submission URI

SubmissionStatusService

public SubmissionStatusService(org.dataconservancy.pass.model.Submission submission,
                               PassClient client)

Supports setting a specific client, primarily for testing.

Parameters:

submission - The submission

client - PASS client

Method Detail

calculateSubmissionStatus

public org.dataconservancy.pass.model.Submission.SubmissionStatus calculateSubmissionStatus()

Calculates the appropriate Submission.SubmissionStatus for the Submission provided. This is based on the status of associated Deposits and RepositoryCopys for submitted records, and SubmissionEvents for unsubmitted records.

Returns:

Calculated submission status

calculateAndUpdateSubmissionStatus

public org.dataconservancy.pass.model.Submission.SubmissionStatus calculateAndUpdateSubmissionStatus()

Calculates the appropriate Submission.SubmissionStatus for the Submission provided.

This is based on the status of associated Deposits and RepositoryCopys for submitted records, and SubmissionEvents for unsubmitted records then updates the status as appropriate.

The UI will typically have responsibility for updating the submissionStatus before the Submission is submitted. Therefore, by default this service will not replace the existing status of an unsubmitted record unless the starting value was null (i.e. it has not been populated yet). To override this constraint, and replace the value anyway, use the method calculateAndUpdateSubmissionStatus(boolean overrideUIStatus) and supply a parameter of true

Returns:

Calculated submission status

calculateAndUpdateSubmissionStatus

public org.dataconservancy.pass.model.Submission.SubmissionStatus calculateAndUpdateSubmissionStatus(boolean overrideUIStatus)

Calculates the appropriate Submission.SubmissionStatus for the Submission provided.

This is based on the status of associated Deposits and RepositoryCopys for submitted records, and SubmissionEvents for unsubmitted records then updates the status as appropriate.

The UI will typically have responsibility for updating the submissionStatus before the Submission is submitted. Therefore, by default this service will not replace the existing status of an unsubmitted record unless the starting value was null (i.e. it has not been populated yet). To override this constraint, set the overrideUIStatus parameter to true

Parameters:

overrideUIStatus - - true will override the current pre-submission status on the Submission record, regardless of whether it was set by the UI. false will not replace the current submission value, and favor the value set by the UI

Returns:

calculated submission status.