Interface DownloadsServiceLocal
-
public interface DownloadsServiceLocalLocal interface for the Downloads service from the Planner API
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringdeleteDownload(java.lang.String id)Deletes the download at the specified IDDownloadgetDownload(java.lang.String id)Returns the download at the specified ID for the current user onlyjava.util.List<Download>getDownloads(DownloadsFilter filter)Returns downloads for the specified job and in the specified time range for the current user onlyjava.util.List<Download>getDownloads(java.lang.String jobName, java.lang.String createdOnFrom, java.lang.String createdOnTo)Returns downloads for the specified job and in the specified time range for the current user only
-
-
-
Method Detail
-
getDownload
Download getDownload(java.lang.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
java.util.List<Download> getDownloads(java.lang.String jobName, java.lang.String createdOnFrom, java.lang.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 jobcreatedOnFrom- start date of rangecreatedOnTo- end date of range- Returns:
- the list of downloads
- Throws:
PubServerException- See Also:
Download
-
deleteDownload
java.lang.String deleteDownload(java.lang.String id) throws PubServerExceptionDeletes the download at the specified ID- Parameters:
id- download ID- Returns:
- ID of deleted download
- Throws:
PubServerException
-
getDownloads
java.util.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
-
-