/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF 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
 *
 *   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 org.apache.synapse;

import javax.xml.namespace.QName;

/**
 * This startup interface will be instantiated to create startup tasks.
 */
public interface Startup extends ManagedLifecycle, Nameable, SynapseArtifact {

    /**
     * This will return the configuration tag QName of the implemented startup
     *
     * @return QName representing the configuration element for the startup
     */
    public abstract QName getTagQName();

    /**
     * Returns the name of the file where this startup is defined
     *
     * @return a file name as a string or null
     */
    public String getFileName();


    /**
     * Set the name of the file name where this startup is defined
     *
     * @param fileName the name of the file as a string
     */
    public void setFileName(String fileName);

    /**
     * Whether the task edited through the management console
     * @return isEdited
     */
    public boolean isEdited();

    /**
     * Set whether the task edited through the management console
     * @param isEdited
     */
    public void setIsEdited(boolean isEdited);

    /**
     * Get the name of the artifact container from which the task deployed
     * @return artifactContainerName
     */
    public String getArtifactContainerName();

    /**
     * Set the name of the artifact container from which the task deployed
     * @param artifactContainerName
     */
    public void setArtifactContainerName(String artifactContainerName);
}