path: root/src/dk.biks.bachelorizer/dk/biks/bachelorizer/Storage.java

// SPDX-FileCopyrightText: 2025 Jonas Smedegaard <dr@jones.dk>
// SPDX-License-Identifier: GPL-3.0-or-later

package dk.biks.bachelorizer;

import java.util.ArrayList;
import java.util.List;

/// Bachelorizer - reference storage model
abstract class Storage {

    /// default constructor
    // (declared explicitly only to silence javadoc)
    Storage() { }

    /// initialization as needed
    void initialize() {
        throw new UnsupportedOperationException(
            "Not implemented yet");
    }

    /// add student
    ///
    /// @param name  Name of student
    void addStudent(final String name) {
        throw new UnsupportedOperationException(
            "Not implemented yet");
    }

    /// get student name
    ///
    /// @return  name of student
    String getStudentName() {
        throw new UnsupportedOperationException(
            "Not implemented yet");
    }

    /// resolve activity index from name
    ///
    /// @param name  activity name
    /// @return      index of activity as integer
    int getActivityIndeks(final String name) {
        throw new UnsupportedOperationException(
            "Not implemented yet");
    }

    /// insert activity into participation
    ///
    /// @param activityIndex  index of activity
    void addParticipation(final int activityIndex) {
        throw new UnsupportedOperationException(
            "Not implemented yet");
    }

    /// list currently participating activities
    ///
    /// @param program  programme name
    /// @return         names of participating activities
    ArrayList<String> getParticipation(final String program) {
        throw new UnsupportedOperationException(
            "Not implemented yet");
    }

    /// purge participation choices
    void clearParticipation() {
        throw new UnsupportedOperationException(
            "Not implemented yet");
    }

    /// list activities within a program
    ///
    /// @param program  programme name
    /// @return         names of contained activities
    ArrayList<String> selectProgram(final String program) {
        throw new UnsupportedOperationException(
            "Not implemented yet");
    }

    /// sum of ECTS points under the given category
    ///
    /// @param program  programme name
    /// @return         ECTS points as String
    String getSumEcts(final String program) {
        throw new UnsupportedOperationException(
            "Not implemented yet");
    }

    /// list of available subject modules
    ///
    /// @return  names of all subject modules as list of strings
    List<String> getAllSubjects() {
        throw new UnsupportedOperationException(
            "Not implemented yet");
    }

    /// list of available activities
    ///
    /// @return  names of all activities as list of strings
    ArrayList<String> getAllActivities() {
        throw new UnsupportedOperationException(
            "Not implemented yet");
    }
}