com.sap.cloud.alert.notification.client.IActionConfigurationClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of clm-sl-alert-notification-client Show documentation

Means for out-of-the-box events management in SAP Alert Notification service for SAP BTP service.

There is a newer version: 1.11.0

Show newest version

package com.sap.cloud.alert.notification.client;

import com.sap.cloud.alert.notification.client.exceptions.AuthorizationException;
import com.sap.cloud.alert.notification.client.exceptions.ClientRequestException;
import com.sap.cloud.alert.notification.client.exceptions.ServerResponseException;
import com.sap.cloud.alert.notification.client.model.configuration.Action;
import com.sap.cloud.alert.notification.client.model.configuration.ConfigurationQueryParameter;
import com.sap.cloud.alert.notification.client.model.configuration.ConfigurationResponse;

import java.util.Map;

public interface IActionConfigurationClient {

    /**
     * Gets all actions of the client.
     *
     * @param queryParameters for specifying page number and page size
     * @throws ClientRequestException  on failure to connect to SAP Alert Notification service for SAP BTP
     * @throws AuthorizationException  on authorization error returned from SAP Alert Notification service for SAP BTP
     * @throws ServerResponseException on error returned from SAP Alert Notification service for SAP BTP
     * @return found results in pages
     */
    ConfigurationResponse getActions(Map queryParameters) throws ClientRequestException, ServerResponseException;

    /**
     * Creates an action.
     *
     * @param action to be created
     * @throws ClientRequestException  on failure to connect to SAP Alert Notification service for SAP BTP
     * @throws AuthorizationException  on authorization error returned from SAP Alert Notification service for SAP BTP
     * @throws ServerResponseException on error returned from SAP Alert Notification service for SAP BTP
     * @return the created action
     */
    Action createAction(Action action) throws ClientRequestException, ServerResponseException;

    /**
     * Gets an action.
     *
     * @param actionName the name of the action to be retrieved
     * @throws ClientRequestException  on failure to connect to SAP Alert Notification service for SAP BTP
     * @throws AuthorizationException  on authorization error returned from SAP Alert Notification service for SAP BTP
     * @throws ServerResponseException on error returned from SAP Alert Notification service for SAP BTP
     * @return the action identified by its name
     */
    Action getAction(String actionName) throws ClientRequestException, ServerResponseException;

    /**
     * Updates an action.
     *
     * @param action to be updated
     * @throws ClientRequestException  on failure to connect to SAP Alert Notification service for SAP BTP
     * @throws AuthorizationException  on authorization error returned from SAP Alert Notification service for SAP BTP
     * @throws ServerResponseException on error returned from SAP Alert Notification service for SAP BTP
     * @return the updated action
     */
    Action updateAction(Action action) throws ClientRequestException, ServerResponseException;

    /**
     * Deletes an action.
     *
     * @param actionName the name of the action to be deleted
     * @throws ClientRequestException  on failure to connect to SAP Alert Notification service for SAP BTP
     * @throws AuthorizationException  on authorization error returned from SAP Alert Notification service for SAP BTP
     * @throws ServerResponseException on error returned from SAP Alert Notification service for SAP BTP
     */
    void deleteAction(String actionName) throws ClientRequestException, ServerResponseException;

}