AlertStorageInterface.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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.
 */

#ifndef ACSDKALERTS_STORAGE_ALERTSTORAGEINTERFACE_H_
#define ACSDKALERTS_STORAGE_ALERTSTORAGEINTERFACE_H_

#include "acsdkAlerts/Alert.h"

#include <Settings/DeviceSettingsManager.h>

#include <list>
#include <memory>
#include <string>
#include <vector>

namespace alexaClientSDK {
namespace acsdkAlerts {
namespace storage {

class AlertStorageInterface {
public:
    virtual ~AlertStorageInterface() = default;

    virtual bool createDatabase() = 0;

    virtual bool open() = 0;

    virtual void close() = 0;

    virtual bool store(std::shared_ptr<Alert> alert) = 0;

    virtual bool storeOfflineAlert(
        const std::string& token,
        const std::string& scheduledTime,
        const std::string& eventTime) = 0;

    virtual bool load(
        std::vector<std::shared_ptr<Alert>>* alertContainer,
        std::shared_ptr<settings::DeviceSettingsManager> settingsManager) = 0;

    virtual bool loadOfflineAlerts(rapidjson::Value* alertContainer, rapidjson::Document::AllocatorType& allocator) = 0;

    virtual bool modify(std::shared_ptr<Alert> alert) = 0;

    virtual bool erase(std::shared_ptr<Alert> alert) = 0;

    virtual bool eraseOffline(const std::string& token, int id) = 0;

    virtual bool bulkErase(const std::list<std::shared_ptr<Alert>>& alertList) = 0;

    virtual bool clearDatabase() = 0;
};

}  // namespace storage
}  // namespace acsdkAlerts
}  // namespace alexaClientSDK

#endif  // ACSDKALERTS_STORAGE_ALERTSTORAGEINTERFACE_H_