/*
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2024 Nordix Foundation
 *  ================================================================================
 *  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.
 *
 *  SPDX-License-Identifier: Apache-2.0
 *  ============LICENSE_END=========================================================
 */

package org.onap.cps.ncmp.api.impl.events.cmsubscription.service;

import java.util.Collection;
import org.onap.cps.ncmp.api.impl.operations.DatastoreType;

public interface CmNotificationSubscriptionPersistenceService {

    String NCMP_DATASPACE_NAME = "NCMP-Admin";
    String CM_SUBSCRIPTIONS_ANCHOR_NAME = "cm-data-subscriptions";

    /**
     * Check if we have an ongoing cm subscription based on the parameters.
     *
     * @param datastoreType the susbcription target datastore type
     * @param cmHandleId the id of the cm handle for the susbcription
     * @param xpath the target xpath
     * @return true for ongoing cmsubscription , otherwise false
     */
    boolean isOngoingCmNotificationSubscription(final DatastoreType datastoreType, final String cmHandleId,
            final String xpath);

    /**
     * Check if the subscription ID is unique against ongoing subscriptions.
     *
     * @param subscriptionId subscription ID
     * @return true if subscriptionId is not used in active subscriptions, otherwise false
     */
    boolean isUniqueSubscriptionId(final String subscriptionId);

    /**
     * Get all ongoing cm notification subscription based on the parameters.
     *
     * @param datastoreType the susbcription target datastore type
     * @param cmHandleId the id of the cm handle for the susbcription
     * @param xpath the target xpath
     * @return collection of subscription ids of ongoing cm notification subscription
     */
    Collection<String> getOngoingCmNotificationSubscriptionIds(final DatastoreType datastoreType,
            final String cmHandleId, final String xpath);

    /**
     * Add cm notification subscription.
     *
     * @param datastoreType the susbcription target datastore type
     * @param cmHandleId the id of the cm handle for the susbcription
     * @param xpath the target xpath
     * @param newSubscriptionId subscription id to be added
     */
    void addCmNotificationSubscription(final DatastoreType datastoreType, final String cmHandleId,
                                       final String xpath, final String newSubscriptionId);

    /**
     * Remove cm notification Subscription.
     *
     * @param datastoreType the susbcription target datastore type
     * @param cmHandleId the id of the cm handle for the susbcription
     * @param xpath the target xpath
     * @param subscriptionId subscription id to remove
     */
    void removeCmNotificationSubscription(final DatastoreType datastoreType, final String cmHandleId,
                                          final String xpath, final String subscriptionId);

}