Package org.craftercms.studio.api.v2.service.dashboard

Interface DashboardService

All Known Implementing Classes:

DashboardServiceImpl

public interface DashboardService

Service that process requests for Dashboard API

Method Summary

Modifier and Type	Method	Description
List<Activity>	getActivitiesForUsers(String siteId, List<String> usernames, List<String> actions, ZonedDateTime dateFrom, ZonedDateTime dateTo, int offset, int limit)	Get activities for users
int	getActivitiesForUsersTotal(String siteId, List<String> usernames, List<String> actions, ZonedDateTime dateFrom, ZonedDateTime dateTo)	Get total number of result for activities of given users
ExpiringContentResult	getContentExpired(String siteId, int offset, int limit)	Get content that expired
ExpiringContentResult	getContentExpiring(String siteId, ZonedDateTime dateFrom, ZonedDateTime dateTo, int offset, int limit)	Get content that is expiring
List<DetailedItem>	getContentPendingApproval(String siteId, List<String> systemTypes, List<org.craftercms.commons.rest.parameters.SortField> sortFields, int offset, int limit)	Get pending content for approval
List<SandboxItem>	getContentPendingApprovalDetail(String siteId, String publishingPackageId, List<org.craftercms.commons.rest.parameters.SortField> sortFields)	Get content pending approval package details
int	getContentPendingApprovalTotal(String siteId, List<String> systemTypes)	Get total number of content packages pending approval
List<SandboxItem>	getContentUnpublished(String siteId, List<String> systemTypes, List<org.craftercms.commons.rest.parameters.SortField> sortFields, int offset, int limit)	Get unpublished content items
int	getContentUnpublishedTotal(String siteId, List<String> systemTypes)	Get total number of unpublished content
List<Activity>	getMyActivities(String siteId, List<String> actions, ZonedDateTime dateFrom, ZonedDateTime dateTo, int offset, int limit)	Get my activities
int	getMyActivitiesTotal(String siteId, List<String> actions, ZonedDateTime dateFrom, ZonedDateTime dateTo)	Get total number of result for my activities
List<DashboardPublishingPackage>	getPublishingHistory(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo, int offset, int limit)	Get publishing history
List<SandboxItem>	getPublishingHistoryDetail(String siteId, String publishingPackageId, int offset, int limit)	Get publishing package details
int	getPublishingHistoryDetailTotalItems(String siteId, String publishingPackageId)	Get publishing package detail total items
int	getPublishingHistoryTotal(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo)	Get total number of result for publishing history with given filters
List<DetailedItem>	getPublishingScheduled(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo, List<String> systemTypes, List<org.craftercms.commons.rest.parameters.SortField> sortFields, int offset, int limit)	Get publishing scheduled
List<SandboxItem>	getPublishingScheduledDetail(String siteId, String publishingPackageId)	Get publishing package details
int	getPublishingScheduledTotal(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo, List<String> systemTypes)	Get total number of result for publishing scheduled with given filters
PublishingStats	getPublishingStats(String siteId, int days)	Get publishing stats for site for given time period

Method Details

getActivitiesForUsersTotal

int getActivitiesForUsersTotal(String siteId,
 List<String> usernames,
 List<String> actions,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo)
                        throws SiteNotFoundException

Get total number of result for activities of given users

Parameters:

siteId - site identifier

usernames - list of usernames

actions - list of actions to filter

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

Returns:

number of results

Throws:

SiteNotFoundException

getActivitiesForUsers

List<Activity> getActivitiesForUsers(String siteId,
 List<String> usernames,
 List<String> actions,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 int offset,
 int limit)
                              throws SiteNotFoundException

Get activities for users

Parameters:

siteId - site identifier

usernames - list of usernames (or prefixes)

actions - list of actions to filter

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

offset - offset of the first result item

limit - number of results to return

Returns:

the list of activities

Throws:

SiteNotFoundException

getMyActivitiesTotal

int getMyActivitiesTotal(String siteId,
 List<String> actions,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo)
                  throws SiteNotFoundException

Get total number of result for my activities

Parameters:

siteId - site identifier

actions - list of actions to filter

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

Returns:

number of results

Throws:

SiteNotFoundException

getMyActivities

List<Activity> getMyActivities(String siteId,
 List<String> actions,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 int offset,
 int limit)
                        throws SiteNotFoundException

Get my activities

Parameters:

siteId - site identifier

actions - list of actions to filter

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

offset - offset of the first result item

limit - number of results to return

Returns:

the list of activities

Throws:

SiteNotFoundException

getContentPendingApprovalTotal

int getContentPendingApprovalTotal(String siteId,
 List<String> systemTypes)
                            throws SiteNotFoundException

Get total number of content packages pending approval

Parameters:

siteId - site identifier

systemTypes - list of system types to filter

Returns:

number of results to return

Throws:

SiteNotFoundException

getContentPendingApproval

List<DetailedItem> getContentPendingApproval(String siteId,
 List<String> systemTypes,
 List<org.craftercms.commons.rest.parameters.SortField> sortFields,
 int offset,
 int limit)
                                      throws ServiceLayerException,
UserNotFoundException

Get pending content for approval

Parameters:

siteId - site identifier

systemTypes - list of system types to filter

sortFields - list of sort fields

offset - offset of the first result item

limit - number of results to return

Returns:

list of DetailedItem waiting for approval

Throws:

ServiceLayerException

UserNotFoundException

getContentPendingApprovalDetail

List<SandboxItem> getContentPendingApprovalDetail(String siteId,
 String publishingPackageId,
 List<org.craftercms.commons.rest.parameters.SortField> sortFields)
                                           throws UserNotFoundException,
ServiceLayerException

Get content pending approval package details

Parameters:

siteId - site identifier

publishingPackageId - publishing package identifier

Returns:

list of sandbox items included in given package

Throws:

UserNotFoundException

ServiceLayerException

getContentUnpublishedTotal

int getContentUnpublishedTotal(String siteId,
 List<String> systemTypes)
                        throws SiteNotFoundException

Get total number of unpublished content

Parameters:

siteId - site identifier

systemTypes - list of system types to filter

Returns:

number of results to return

Throws:

SiteNotFoundException

getContentUnpublished

List<SandboxItem> getContentUnpublished(String siteId,
 List<String> systemTypes,
 List<org.craftercms.commons.rest.parameters.SortField> sortFields,
 int offset,
 int limit)
                                 throws UserNotFoundException,
ServiceLayerException

Get unpublished content items

Parameters:

siteId - site identifier

systemTypes - list of system types to filter

sortFields - list of sort fields

offset - offset of the first result item

limit - number of results to return

Returns:

list of unpublished content items

Throws:

UserNotFoundException

ServiceLayerException

getContentExpiring

ExpiringContentResult getContentExpiring(String siteId,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 int offset,
 int limit)
                                  throws AuthenticationException,
ServiceLayerException,
UserNotFoundException

Get content that is expiring

Parameters:

siteId - site identifier

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

offset - offset of the first result item

limit - number of results to return

Returns:

list of content items that is expiring

Throws:

AuthenticationException

ServiceLayerException

UserNotFoundException

getContentExpired

ExpiringContentResult getContentExpired(String siteId,
 int offset,
 int limit)
                                 throws AuthenticationException,
ServiceLayerException,
UserNotFoundException

Get content that expired

Parameters:

siteId - site identifier

offset - offset of the first result item

limit - number of results to return

Returns:

list of content items that expired

Throws:

AuthenticationException

ServiceLayerException

UserNotFoundException

getPublishingScheduledTotal

int getPublishingScheduledTotal(String siteId,
 String publishingTarget,
 String approver,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 List<String> systemTypes)
                         throws SiteNotFoundException

Get total number of result for publishing scheduled with given filters

Parameters:

siteId - site identifier

publishingTarget - publishing target to filter by

approver - approver user to filter by

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

systemTypes - list of system types to filter

Returns:

number of results

Throws:

SiteNotFoundException

getPublishingScheduled

List<DetailedItem> getPublishingScheduled(String siteId,
 String publishingTarget,
 String approver,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 List<String> systemTypes,
 List<org.craftercms.commons.rest.parameters.SortField> sortFields,
 int offset,
 int limit)
                                   throws ServiceLayerException,
UserNotFoundException

Get publishing scheduled

Parameters:

siteId - site identifier

publishingTarget - publishing target to filter by

approver - approver user to filter by

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

systemTypes - list of system types to filter

sortFields - list of sort fields

offset - offset of the first result item

limit - number of results to return

sortFields - list of sort fields

Returns:

list of DetailedItem scheduled for publishing

Throws:

ServiceLayerException

UserNotFoundException

getPublishingScheduledDetail

List<SandboxItem> getPublishingScheduledDetail(String siteId,
 String publishingPackageId)
                                        throws UserNotFoundException,
ServiceLayerException

Get publishing package details

Parameters:

siteId - site identifier

publishingPackageId - publishing package identifier

Returns:

list of sandbox items included in given package

Throws:

UserNotFoundException

ServiceLayerException

getPublishingHistoryTotal

int getPublishingHistoryTotal(String siteId,
 String publishingTarget,
 String approver,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo)
                       throws SiteNotFoundException

Get total number of result for publishing history with given filters

Parameters:

siteId - site identifier

publishingTarget - publishing target to filter by

approver - approver user to filter by

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

Returns:

number of results

Throws:

SiteNotFoundException

getPublishingHistory

List<DashboardPublishingPackage> getPublishingHistory(String siteId,
 String publishingTarget,
 String approver,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 int offset,
 int limit)
                                               throws SiteNotFoundException

Get publishing history

Parameters:

siteId - site identifier

publishingTarget - publishing target to filter by

approver - approver user to filter by

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

offset - offset of the first result item

limit - number of results to return

Returns:

Throws:

SiteNotFoundException

getPublishingHistoryDetailTotalItems

int getPublishingHistoryDetailTotalItems(String siteId,
 String publishingPackageId)
                                  throws SiteNotFoundException

Get publishing package detail total items

Parameters:

siteId - site identifier

publishingPackageId - publishing package identifier

Returns:

number of package items

Throws:

SiteNotFoundException

getPublishingHistoryDetail

List<SandboxItem> getPublishingHistoryDetail(String siteId,
 String publishingPackageId,
 int offset,
 int limit)
                                      throws UserNotFoundException,
ServiceLayerException

Get publishing package details

Parameters:

siteId - site identifier

publishingPackageId - publishing package identifier

offset - offset of the first result item

limit - number of results to return

Returns:

list of sandbox items included in given package

Throws:

UserNotFoundException

ServiceLayerException

getPublishingStats

PublishingStats getPublishingStats(String siteId,
 int days)
                            throws SiteNotFoundException

Get publishing stats for site for given time period

Parameters:

siteId - site identifier

days - number of days

Returns:

publishing stats

Throws:

SiteNotFoundException