au.org.intersect.exsite9.service
Class SubmissionPackageService

java.lang.Object
  au.org.intersect.exsite9.service.SubmissionPackageService

All Implemented Interfaces:

ISubmissionPackageService

public final class SubmissionPackageService
extends java.lang.Object
implements ISubmissionPackageService

A service for manipulating SubmissionPackages

Constructor Summary

SubmissionPackageService(javax.persistence.EntityManagerFactory entityManagerFactory, SubmissionPackageDAOFactory submissionPackageDAOFactory, ProjectDAOFactory projectDAOFactory)

Method Summary

java.lang.String	buildXMLForSubmissionPackage(Project project, SubmissionPackage submissionPackage) Builds the xml for a submission package
org.eclipse.jface.operation.IRunnableWithProgress	buildZIPForSubmissionPackage(Project project, SubmissionPackage submissionPackage, java.io.File fileToWrite) Get job to build the ZIP for a submission package
SubmissionPackage	createSubmissionPackage(Project project, java.lang.String name, java.lang.String description, java.util.List<ResearchFile> researchFiles) Creates a Submission Package.
void	deleteSubmissionPackage(SubmissionPackage submissionPackage) Deletes a Submission Package.
SubmissionPackage	findSubmissionPackageById(java.lang.Long id) Finds a submission package by ID.
java.util.List<SubmissionPackage>	findSubmissionPackagesWithResearchFile(ResearchFile researchFile) Obtains any submission packages that contain the provided research file.
SubmissionPackage	updateSubmissionPackage(SubmissionPackage submissionPackage, java.util.List<ResearchFile> researchFiles) Updates a submission Package.
SubmissionPackage	updateSubmissionPackage(SubmissionPackage submissionPackage, java.lang.String name, java.lang.String description, java.util.List<ResearchFile> researchFiles) Updates a Submission Package.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubmissionPackageService

public SubmissionPackageService(javax.persistence.EntityManagerFactory entityManagerFactory,
                                SubmissionPackageDAOFactory submissionPackageDAOFactory,
                                ProjectDAOFactory projectDAOFactory)

Method Detail

createSubmissionPackage

public SubmissionPackage createSubmissionPackage(Project project,
                                                 java.lang.String name,
                                                 java.lang.String description,
                                                 java.util.List<ResearchFile> researchFiles)

Description copied from interface: ISubmissionPackageService

Creates a Submission Package.

Specified by:

createSubmissionPackage in interface ISubmissionPackageService

Parameters:

project - The project the submission package belongs to.

name - The name of the submission package.

description - The description of the submission package.

researchFiles - The research files contained in the submission package.

Returns:

The created submission package.

updateSubmissionPackage

public SubmissionPackage updateSubmissionPackage(SubmissionPackage submissionPackage,
                                                 java.lang.String name,
                                                 java.lang.String description,
                                                 java.util.List<ResearchFile> researchFiles)

Description copied from interface: ISubmissionPackageService

Updates a Submission Package.

Specified by:

updateSubmissionPackage in interface ISubmissionPackageService

Parameters:

submissionPackage - The submission package to update.

name - The new name of the submission package.

description - The new description of the submission package.

researchFiles - The new set of research files for the submission package.

Returns:

The updated submission package.

updateSubmissionPackage

public SubmissionPackage updateSubmissionPackage(SubmissionPackage submissionPackage,
                                                 java.util.List<ResearchFile> researchFiles)

Description copied from interface: ISubmissionPackageService

Updates a submission Package.

Specified by:

updateSubmissionPackage in interface ISubmissionPackageService

Parameters:

submissionPackage - The submission package to update.

researchFiles - The new set of research files for the submission package.

Returns:

The updates submission package.

findSubmissionPackageById

public SubmissionPackage findSubmissionPackageById(java.lang.Long id)

Description copied from interface: ISubmissionPackageService

Finds a submission package by ID.

Specified by:

findSubmissionPackageById in interface ISubmissionPackageService

Parameters:

id - The ID of the submission package to find.

Returns:

The submission package.

deleteSubmissionPackage

public void deleteSubmissionPackage(SubmissionPackage submissionPackage)

Description copied from interface: ISubmissionPackageService

Deletes a Submission Package.

Specified by:

deleteSubmissionPackage in interface ISubmissionPackageService

Parameters:

submissionPackage - The submission package to delete.

buildXMLForSubmissionPackage

public java.lang.String buildXMLForSubmissionPackage(Project project,
                                                     SubmissionPackage submissionPackage)

Description copied from interface: ISubmissionPackageService

Builds the xml for a submission package

Specified by:

buildXMLForSubmissionPackage in interface ISubmissionPackageService

Parameters:

project - The project

submissionPackage - The submission package

Returns:

buildZIPForSubmissionPackage

public org.eclipse.jface.operation.IRunnableWithProgress buildZIPForSubmissionPackage(Project project,
                                                                                      SubmissionPackage submissionPackage,
                                                                                      java.io.File fileToWrite)

Description copied from interface: ISubmissionPackageService

Get job to build the ZIP for a submission package

Specified by:

buildZIPForSubmissionPackage in interface ISubmissionPackageService

Parameters:

project - The project

submissionPackage - The submission package

fileToWrite - The file to write the ZIP to.

Returns:

The RunnableWithError - so we can execute it in the UI thread wrapped by a progress dialog.

findSubmissionPackagesWithResearchFile

public java.util.List<SubmissionPackage> findSubmissionPackagesWithResearchFile(ResearchFile researchFile)

Description copied from interface: ISubmissionPackageService

Obtains any submission packages that contain the provided research file.

Specified by:

findSubmissionPackagesWithResearchFile in interface ISubmissionPackageService

Parameters:

researchFile - The research file.

Returns:

The submission packages that contain the research file.