[PORTAL-16 PORTAL-18] Widget ms; staging
[portal.git] / ecomp-portal-BE-common / src / main / java / org / openecomp / portalapp / portal / service / UserNotificationService.java
index 063fdf0..447cacf 100644 (file)
-/*-\r
- * ================================================================================\r
- * ECOMP Portal\r
- * ================================================================================\r
- * Copyright (C) 2017 AT&T Intellectual Property\r
- * ================================================================================\r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- * \r
- *      http://www.apache.org/licenses/LICENSE-2.0\r
- * \r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- * ================================================================================\r
- */\r
-package org.openecomp.portalapp.portal.service;\r
-\r
-import java.util.List;\r
-\r
-import org.openecomp.portalapp.portal.domain.EPUser;\r
-import org.openecomp.portalapp.portal.domain.EcompAppRole;\r
-import org.openecomp.portalapp.portal.transport.EpNotificationItem;\r
-import org.openecomp.portalapp.portal.transport.EpNotificationItemVO;\r
-import org.openecomp.portalapp.portal.transport.EpRoleNotificationItem;\r
-\r
-public interface UserNotificationService {\r
-\r
-       List<EpNotificationItem> getNotifications(Long userId);\r
-\r
-       List<EpRoleNotificationItem> getNotificationRoles(Long notificationId);\r
-\r
-       List<EcompAppRole> getAppRoleList();\r
-       /**\r
-        * Marks the notification as viewed by the specified user.\r
-        * \r
-        * @param notificationId\r
-        * @param userId\r
-        */\r
-       void setNotificationRead(Long notificationId, int userId);\r
-\r
-       String saveNotification(EpNotificationItem notificationItem) throws Exception;\r
-\r
-       List<EpNotificationItemVO> getNotificationHistoryVO(Long userId);\r
-\r
-       List<EpNotificationItemVO> getAdminNotificationVOS();\r
-       \r
-       List<EPUser> getUsersByOrgIds(List<String> OrgIds);\r
-\r
-       List<String> getMessageRecipients(Long notificationId);\r
-\r
-}\r
+/*-
+ * ================================================================================
+ * ECOMP Portal
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ================================================================================
+ */
+package org.openecomp.portalapp.portal.service;
+
+import java.util.List;
+
+import org.openecomp.portalapp.portal.domain.EPUser;
+import org.openecomp.portalapp.portal.domain.EcompAppRole;
+import org.openecomp.portalapp.portal.transport.EpNotificationItem;
+import org.openecomp.portalapp.portal.transport.EpNotificationItemVO;
+import org.openecomp.portalapp.portal.transport.EpRoleNotificationItem;
+
+public interface UserNotificationService {
+
+       /**
+        * Gets the specified notifications with userId from ep_notification
+        * 
+        * @param userId
+        * 
+        * @return the notifications with the specified userId
+        */
+
+       List<EpNotificationItem> getNotifications(Long userId);
+
+       /**
+        * Gets the specified roles from ep_role_notification
+        * 
+        * @param notificationId
+        * 
+        * @return the roles for a specified notification
+        */
+
+       List<EpRoleNotificationItem> getNotificationRoles(Long notificationId);
+
+       /**
+        * Get all app role list from the fn_app and fn_role table
+        * 
+        * @return list of all roles associated with the applications
+        */
+       List<EcompAppRole> getAppRoleList();
+
+       /**
+        * Marks the notification as viewed by the specified user.
+        * 
+        * @param notificationId
+        * @param userId
+        */
+       void setNotificationRead(Long notificationId, int userId);
+
+       /**
+        * Saves the specified notification to the table ep_notification
+        * 
+        * @param notificationItem
+        * @throws Exception
+        */
+
+       String saveNotification(EpNotificationItem notificationItem) throws Exception;
+
+       /**
+        * Gets the specified notification with the userId for view all recent
+        * notifications
+        * 
+        * @param userId
+        * 
+        * @return the notification list
+        */
+
+       List<EpNotificationItemVO> getNotificationHistoryVO(Long userId);
+
+       /**
+        * Gets the notifications with the userId for user notifications
+        * 
+        * @param userId
+        * 
+        * @return the notification list
+        */
+
+       List<EpNotificationItemVO> getAdminNotificationVOS(Long userId);
+
+       /**
+        * Gets the user list from fn_user
+        * 
+        * @param OrgIds
+        * 
+        * @return the users list
+        */
+
+       List<EPUser> getUsersByOrgIds(List<String> OrgIds);
+
+       /**
+        * Gets the received recipient to whom the notification is delivered from
+        * external system
+        * 
+        * @param notificationId
+        * 
+        * @return the active users
+        */
+
+       List<String> getMessageRecipients(Long notificationId);
+
+       /**
+        * delete the records from ep_notification table when the endtime is more
+        * than 3 months
+        * 
+        */
+
+       void deleteNotificationsFromEpNotificationTable();
+
+       /**
+        * delete the records from ep_user_notification table when the endtime is
+        * more than 3 months
+        * 
+        */
+       void deleteNotificationsFromEpUserNotificationTable();
+
+       /**
+        * delete the records from ep_role_notification table when the endtime is
+        * more than 3 months
+        * 
+        */
+       void deleteNotificationsFromEpRoleNotificationTable();
+
+}