/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * licenses this file to you 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 the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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 org.apereo.portal.io.xml.ssd;

import java.util.Arrays;
import java.util.List;
import javax.xml.namespace.QName;
import org.apereo.portal.io.xml.AbstractPortalDataType;
import org.apereo.portal.io.xml.PortalDataKey;
import org.apereo.portal.layout.om.IStylesheetDescriptor;

/**
 * Describes the {@link IStylesheetDescriptor} for import and export.
 *
 */
public class StylesheetDescriptorPortalDataType extends AbstractPortalDataType {
    public static final QName STYLESHEET_DESCRIPTOR_QNAME =
            new QName(
                    "https://source.jasig.org/schemas/uportal/io/stylesheet-descriptor",
                    "stylesheet-descriptor");

    /** @deprecated used for importing old data files */
    @Deprecated public static final QName LEGACY_STRUCTURE_QNAME = new QName("structure");

    /** @deprecated used for importing old data files */
    @Deprecated public static final QName LEGACY_THEME_QNAME = new QName("theme");

    public static final PortalDataKey IMPORT_40_DATA_KEY =
            new PortalDataKey(STYLESHEET_DESCRIPTOR_QNAME, null, "4.0");

    /** @deprecated used for importing old data files */
    @Deprecated
    public static final PortalDataKey IMPORT_26_STRUCTURE_DATA_KEY =
            new PortalDataKey(
                    LEGACY_STRUCTURE_QNAME,
                    "classpath://org/jasig/portal/io/import-structure_v2-6.crn",
                    null);

    /** @deprecated used for importing old data files */
    @Deprecated
    public static final PortalDataKey IMPORT_26_THEME_DATA_KEY =
            new PortalDataKey(
                    LEGACY_THEME_QNAME,
                    "classpath://org/jasig/portal/io/import-theme_v2-6.crn",
                    null);

    private static final List<PortalDataKey> PORTAL_DATA_KEYS =
            Arrays.asList(
                    IMPORT_26_THEME_DATA_KEY, IMPORT_26_STRUCTURE_DATA_KEY, IMPORT_40_DATA_KEY);

    public StylesheetDescriptorPortalDataType() {
        super(STYLESHEET_DESCRIPTOR_QNAME);
    }

    @Override
    public List<PortalDataKey> getDataKeyImportOrder() {
        return PORTAL_DATA_KEYS;
    }

    @Override
    public String getTitleCode() {
        return "Stylesheet Descriptor";
    }

    @Override
    public String getDescriptionCode() {
        return "Stylesheet Descriptors published in the portal";
    }
}