Package com.priint.pubserver.plannerapi.interfaces

Interface DownloadsServiceLocal

public interface DownloadsServiceLocal

Local interface for the Downloads service from the Planner API

Method Summary

Modifier and Type	Method	Description
String	deleteDownload(String id)	Deletes the download at the specified ID
Download	getDownload(String id)	Returns the download at the specified ID for the current user only
List<Download>	getDownloads(DownloadsFilter filter)	Returns downloads for the specified job and in the specified time range for the current user only
List<Download>	getDownloads(String jobName, String createdOnFrom, String createdOnTo)	Returns downloads for the specified job and in the specified time range for the current user only

Method Details

getDownload

Download getDownload(String id)
              throws PubServerException

Returns the download at the specified ID for the current user only

Parameters:

id - download ID

Returns:

the download

Throws:

PubServerException

See Also:

• Download

getDownloads

List<Download> getDownloads(String jobName,
 String createdOnFrom,
 String createdOnTo)
                     throws PubServerException

Returns downloads for the specified job and in the specified time range for the current user only

Parameters:

jobName - name of the job

createdOnFrom - start date of range

createdOnTo - end date of range

Returns:

the list of downloads

Throws:

PubServerException

See Also:

• Download

deleteDownload

String deleteDownload(String id)
               throws PubServerException

Deletes the download at the specified ID

Parameters:

id - download ID

Returns:

ID of deleted download

Throws:

PubServerException

getDownloads

List<Download> getDownloads(DownloadsFilter filter)
                     throws PubServerException

Returns downloads for the specified job and in the specified time range for the current user only

Parameters:

filter - search criteria in the DownloadsFilter object

Throws:

PubServerException

See Also:

• Download
• DocumentsFilter