All Known Implementing Classes:

PublishServiceImpl
```
public interface PublishService
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cancelPublishingPackages(String siteId, List<String> packageIds)`	Cancel publishing packages
`List<PublishingTarget>`	`getAvailablePublishingTargets(String siteId)`	Get available publishing targets for given site
`List<DeploymentHistoryGroup>`	`getDeploymentHistory(String siteId, int daysFromToday, int numberOfItems, String filterType)`	Get deployment history
`List<PublishingDashboardItem>`	`getPublishingHistory(String siteId, String environment, String path, String publisher, ZonedDateTime dateFrom, ZonedDateTime dateTo, String contentType, long state, String sortBy, String order, int offset, int limit)`	Get deployment history items for given search parameters
`int`	`getPublishingHistoryTotal(String siteId, String environment, String path, String publisher, ZonedDateTime dateFrom, ZonedDateTime dateTo, String contentType, long state)`	Get total number of publishing history items for given search parameters
`PublishingPackageDetails`	`getPublishingPackageDetails(String siteId, String packageId)`	Get publishing package details
`List<PublishingPackage>`	`getPublishingPackages(String siteId, String environment, String path, List<String> states, int offset, int limit)`	Get publishing packages for given search parameters
`int`	`getPublishingPackagesTotal(String siteId, String environment, String path, List<String> states)`	Get total number of publishing packages for given search parameters
`boolean`	`isSitePublished(String siteId)`	Check if site has ever been published.
`RepositoryChanges`	`publishAll(String siteId, String publishingTarget, String comment)`	Publishes all changes for the given site & target

Method Detail

getPublishingPackagesTotal

int getPublishingPackagesTotal(String siteId,
                               String environment,
                               String path,
                               List<String> states)
                        throws SiteNotFoundException

Get total number of publishing packages for given search parameters

Parameters:: siteId - site identifier; environment - publishing environment; path - regular expression for paths; states - publishing package states
Returns:: total number of publishing packages
Throws:: SiteNotFoundException - site not found

getPublishingPackages

List<PublishingPackage> getPublishingPackages(String siteId,
                                              String environment,
                                              String path,
                                              List<String> states,
                                              int offset,
                                              int limit)
                                       throws SiteNotFoundException

Get publishing packages for given search parameters

Parameters:: siteId - site identifier; environment - publishing environment; path - regular expression for paths; states - publishing package states; offset - offset for pagination; limit - limit for pagination
Returns:: list of publishing packages
Throws:: SiteNotFoundException - site not found

getPublishingPackageDetails

PublishingPackageDetails getPublishingPackageDetails(String siteId,
                                                     String packageId)
                                              throws SiteNotFoundException,
                                                     PublishingPackageNotFoundException

Get publishing package details

Parameters:: siteId - site identifier; packageId - package identifier
Returns:: publishing package details
Throws:: SiteNotFoundException - site not found; PublishingPackageNotFoundException

cancelPublishingPackages

void cancelPublishingPackages(String siteId,
                              List<String> packageIds)
                       throws ServiceLayerException,
                              UserNotFoundException

Cancel publishing packages

Parameters:: siteId - site identifier; packageIds - list of package identifiers
Throws:: SiteNotFoundException - site not found; ServiceLayerException; UserNotFoundException

getPublishingHistoryTotal

int getPublishingHistoryTotal(String siteId,
                              String environment,
                              String path,
                              String publisher,
                              ZonedDateTime dateFrom,
                              ZonedDateTime dateTo,
                              String contentType,
                              long state)

Get total number of publishing history items for given search parameters

Parameters:: siteId - site identifier; environment - environment to get publishing history; path - regular expression to filter paths; publisher - filter publishing history for specified user; dateFrom - lower boundary for date range; dateTo - upper boundary for date range; contentType - publishing history for specified content type; state - filter items by their state
Returns:: total number of deployment history items

getPublishingHistory

List<PublishingDashboardItem> getPublishingHistory(String siteId,
                                                   String environment,
                                                   String path,
                                                   String publisher,
                                                   ZonedDateTime dateFrom,
                                                   ZonedDateTime dateTo,
                                                   String contentType,
                                                   long state,
                                                   String sortBy,
                                                   String order,
                                                   int offset,
                                                   int limit)

Get deployment history items for given search parameters

Parameters:: siteId - site identifier; environment - environment to get publishing history; path - regular expression to filter paths; publisher - filter publishing history for specified user; dateFrom - lower boundary for date range; dateTo - upper boundary for date range; contentType - publishing history for specified content type; state - filter items by their state; sortBy - sort publishing history; order - apply order to publishing history; offset - offset of the first item in the result set; limit - number of items to return
Returns:: total number of publishing packages

getDeploymentHistory

List<DeploymentHistoryGroup> getDeploymentHistory(String siteId,
                                                  int daysFromToday,
                                                  int numberOfItems,
                                                  String filterType)
                                           throws SiteNotFoundException

Get deployment history

Parameters:: siteId - site identifier; daysFromToday - number of days for history; numberOfItems - number of items to display; filterType - filter results by filter type
Returns:
Throws:: SiteNotFoundException

getAvailablePublishingTargets
```
List<PublishingTarget> getAvailablePublishingTargets(String siteId)
                                              throws SiteNotFoundException
```
Get available publishing targets for given site

Parameters:

siteId - site identifier

Returns:

list of available publishing targets

Throws:

SiteNotFoundException - Site doesn't exist

isSitePublished
```
boolean isSitePublished(String siteId)
                 throws SiteNotFoundException
```
Check if site has ever been published.

Parameters:

siteId - site identifier

Returns:

true if site has been published at least once, otherwise false

Throws:

SiteNotFoundException - Site doesn't exist

publishAll

RepositoryChanges publishAll(String siteId,
                             String publishingTarget,
                             String comment)
                      throws ServiceLayerException,
                             UserNotFoundException

Publishes all changes for the given site & target

Parameters:: siteId - the id of the site; publishingTarget - the publishing target; comment - submission comment
Returns:: result of the publishing
Throws:: ServiceLayerException - if there is any error during publishing; UserNotFoundException

Interface PublishService