Package com.synopsys.integration.blackduck.service.dataservice

Class NotificationService

java.lang.Object

com.synopsys.integration.blackduck.service.DataService

com.synopsys.integration.blackduck.service.dataservice.NotificationService

public class NotificationService
extends DataService

Field Summary

Fields inherited from class com.synopsys.integration.blackduck.service.DataService

blackDuckApiClient, blackDuckRequestFactory, logger

Constructor Summary

Constructors

Constructor	Description
NotificationService(BlackDuckApiClient blackDuckApiClient, BlackDuckRequestFactory blackDuckRequestFactory, com.synopsys.integration.log.IntLogger logger)

Method Summary

Modifier and Type	Method	Description
java.util.List<com.synopsys.integration.blackduck.api.manual.view.NotificationView>	getAllNotifications(java.util.Date startDate, java.util.Date endDate)
java.util.List<com.synopsys.integration.blackduck.api.manual.view.NotificationUserView>	getAllUserNotifications(com.synopsys.integration.blackduck.api.generated.view.UserView user, java.util.Date startDate, java.util.Date endDate)
java.util.List<com.synopsys.integration.blackduck.api.manual.view.NotificationView>	getFilteredNotifications(java.util.Date startDate, java.util.Date endDate, java.util.List<java.lang.String> notificationTypesToInclude)
java.util.List<com.synopsys.integration.blackduck.api.manual.view.NotificationUserView>	getFilteredUserNotifications(com.synopsys.integration.blackduck.api.generated.view.UserView user, java.util.Date startDate, java.util.Date endDate, java.util.List<java.lang.String> notificationTypesToInclude)
java.util.Date	getLatestNotificationDate()
java.util.Date	getLatestUserNotificationDate(com.synopsys.integration.blackduck.api.generated.view.UserView userView)
BlackDuckPageResponse<com.synopsys.integration.blackduck.api.manual.view.NotificationView>	getPageOfNotifications(java.util.Date startDate, java.util.Date endDate, BlackDuckPageDefinition blackDuckPageDefinition)
BlackDuckPageResponse	getPageOfUserNotifications(com.synopsys.integration.blackduck.api.generated.view.UserView user, java.util.Date startDate, java.util.Date endDate, BlackDuckPageDefinition blackDuckPageDefinition)

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationService

public NotificationService(BlackDuckApiClient blackDuckApiClient,
                           BlackDuckRequestFactory blackDuckRequestFactory,
                           com.synopsys.integration.log.IntLogger logger)

Method Detail

getAllNotifications

public java.util.List<com.synopsys.integration.blackduck.api.manual.view.NotificationView> getAllNotifications(java.util.Date startDate,
                                                                                                               java.util.Date endDate)
                                                                                                        throws com.synopsys.integration.exception.IntegrationException

Throws:

com.synopsys.integration.exception.IntegrationException

getPageOfNotifications

public BlackDuckPageResponse<com.synopsys.integration.blackduck.api.manual.view.NotificationView> getPageOfNotifications(java.util.Date startDate,
                                                                                                                         java.util.Date endDate,
                                                                                                                         BlackDuckPageDefinition blackDuckPageDefinition)
                                                                                                                  throws com.synopsys.integration.exception.IntegrationException

Throws:

com.synopsys.integration.exception.IntegrationException

getAllUserNotifications

public java.util.List<com.synopsys.integration.blackduck.api.manual.view.NotificationUserView> getAllUserNotifications(com.synopsys.integration.blackduck.api.generated.view.UserView user,
                                                                                                                       java.util.Date startDate,
                                                                                                                       java.util.Date endDate)
                                                                                                                throws com.synopsys.integration.exception.IntegrationException

Throws:

com.synopsys.integration.exception.IntegrationException

getPageOfUserNotifications

public BlackDuckPageResponse getPageOfUserNotifications(com.synopsys.integration.blackduck.api.generated.view.UserView user,
                                                        java.util.Date startDate,
                                                        java.util.Date endDate,
                                                        BlackDuckPageDefinition blackDuckPageDefinition)
                                                 throws com.synopsys.integration.exception.IntegrationException

Throws:

com.synopsys.integration.exception.IntegrationException

getFilteredNotifications

public java.util.List<com.synopsys.integration.blackduck.api.manual.view.NotificationView> getFilteredNotifications(java.util.Date startDate,
                                                                                                                    java.util.Date endDate,
                                                                                                                    java.util.List<java.lang.String> notificationTypesToInclude)
                                                                                                             throws com.synopsys.integration.exception.IntegrationException

Throws:

com.synopsys.integration.exception.IntegrationException

getFilteredUserNotifications

public java.util.List<com.synopsys.integration.blackduck.api.manual.view.NotificationUserView> getFilteredUserNotifications(com.synopsys.integration.blackduck.api.generated.view.UserView user,
                                                                                                                            java.util.Date startDate,
                                                                                                                            java.util.Date endDate,
                                                                                                                            java.util.List<java.lang.String> notificationTypesToInclude)
                                                                                                                     throws com.synopsys.integration.exception.IntegrationException

Throws:

com.synopsys.integration.exception.IntegrationException

getLatestNotificationDate

public java.util.Date getLatestNotificationDate()
                                         throws com.synopsys.integration.exception.IntegrationException

Returns:

The java.util.Date of the most recent notification. If there are no notifications, the current date will be returned. This can set an initial start time window for all future notifications.

Throws:

com.synopsys.integration.exception.IntegrationException

getLatestUserNotificationDate

public java.util.Date getLatestUserNotificationDate(com.synopsys.integration.blackduck.api.generated.view.UserView userView)
                                             throws com.synopsys.integration.exception.IntegrationException

Returns:

The java.util.Date of the most recent notification in the user's stream. If there are no notifications, the current date will be returned. This can set an initial start time window for all future notifications.

Throws:

com.synopsys.integration.exception.IntegrationException