/*-
 * ~~~~~~licensing~~~~~~
 * object-runtime-core
 * ==========
 * Copyright (C) 2020 - 2025 EmDev LLC
 * ==========
 * You may not use this file except in accordance with the License Terms of the Copyright
 * Holder located at: https://entaxy.ru/eula . All copyrights, all intellectual property
 * rights to the Software and any copies are the property of the Copyright Holder. Unless
 * it is explicitly allowed the Copyright Holder, the User is prohibited from using the
 * Software for commercial purposes to provide services to third parties.
 * 
 * The Copyright Holder hereby declares that the Software is provided on an "AS IS".
 * Under no circumstances does the Copyright Holder guarantee or promise that the
 * Software provided by him will be suitable or not suitable for the specific purposes
 * of the User, that the Software will meet all commercial and personal subjective
 * expectations of the User, that the Software will work properly, without technical
 * errors, quickly and uninterruptedly.
 * 
 * Under no circumstances shall the Copyright Holder or its Affiliates is not liable
 * to the User for any direct or indirect losses of the User, his expenses or actual
 * damage, including, downtime; loss of bussines; lost profit; lost earnings; loss
 * or damage to data, property, etc.
 * ~~~~~~/licensing~~~~~~
 */
package ru.entaxy.platform.objects.runtime;

import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import org.apache.commons.collections4.MapUtils;

public interface EntaxyRuntimeObjectContainer {

    public enum ENTAXY_RUNTIME_OBJECT_CONTAINER_STATE {
        Installed,
        Resolved,
        Unknown,
        GracePeriod,
        Waiting,
        Starting,
        Active,
        Stopping,
        Failure,
    }

    public interface SEARCH {

        String ATTR_ID = "id";
        String ATTR_TYPE = "type";
        String ATTR_NAME = "name";
        String ATTR_STATE = "state";

        List<String> STANDARD_ATTRIBUTES_LIST = Arrays.asList(new String[] {
            ATTR_ID, ATTR_TYPE, ATTR_NAME, ATTR_STATE
        });

        @SuppressWarnings("unchecked")
        Map<String, String> STANDARD_ATTRIBUTES = MapUtils.putAll(new LinkedHashMap<String, String>(), new String[][] {
            {ATTR_ID, "Container id"},
            {ATTR_TYPE, "Container type"},
            {ATTR_NAME, "Container name"},
            {ATTR_STATE, "Container state"}
        });
    }

    String getId();

    String getName();

    default String getType() {
        return "bundle";
    }

    ENTAXY_RUNTIME_OBJECT_CONTAINER_STATE getState();

    List<EntaxyRuntimeObject> getObjects();

    List<EntaxyRuntimeObjectContainer> getParentContainers();

    List<EntaxyRuntimeObjectContainer> getChildContainers();

    List<EntaxyRuntimeObjectContainer> getDependencies();

    List<EntaxyRuntimeObjectContainer> getDependent();

    List<EntaxyRuntimeObjectContainer> getRelatedContainers();

    List<EntaxyRuntimeObjectContainer> getIncomingRelatedContainers();

}
