/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * 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 com.android.tv.dvr;

import android.support.annotation.MainThread;
import com.android.tv.dvr.data.ScheduledRecording;
import com.android.tv.dvr.data.ScheduledRecording.RecordingState;
import com.android.tv.dvr.data.SeriesRecording;

/**
 * Full data manager.
 *
 * <p>The following operations need to be synced with permanent storage. The following commands are
 * for internal use only. Do not call them from UI directly.
 */
@MainThread
public interface WritableDvrDataManager extends DvrDataManager {
    /** Adds new recordings. */
    void addScheduledRecording(ScheduledRecording... scheduledRecordings);

    /** Adds new series recordings. */
    void addSeriesRecording(SeriesRecording... seriesRecordings);

    /** Removes recordings. */
    void removeScheduledRecording(ScheduledRecording... scheduledRecordings);

    /**
     * Removes recordings. If {@code forceRemove} is {@code true}, the schedule will be permanently
     * removed instead of changing the state to DELETED.
     */
    void removeScheduledRecording(boolean forceRemove, ScheduledRecording... scheduledRecordings);

    /** Removes series recordings. */
    void removeSeriesRecording(SeriesRecording... seasonSchedules);

    /** Updates existing recordings. */
    void updateScheduledRecording(ScheduledRecording... scheduledRecordings);

    /** Updates existing series recordings. */
    void updateSeriesRecording(SeriesRecording... seriesRecordings);

    /** Changes the state of the recording. */
    void changeState(ScheduledRecording scheduledRecording, @RecordingState int newState);

    /**
     * Changes the state of the recording.
     *
     * @param reason the reason of this change
     */
    void changeState(
            ScheduledRecording scheduledRecording, @RecordingState int newState, int reason);

    /**
     * Remove all the records related to the input.
     *
     * <p>Note that this should be called after the input was removed.
     */
    void forgetStorage(String inputId);
}