/*
 * Copyright (c) 2015 iTAC Software AG, Germany. All Rights Reserved.
 * 
 * This software is protected by copyright. Under no circumstances may any part of this file in any form be copied,
 * printed, edited or otherwise distributed, be stored in a retrieval system, or be translated into another language
 * without the written permission of iTAC Software AG.
 */
using System;

namespace com.itac.mes.commonsmt
{
    /// <summary>
    /// Interface IMesServicesChannel
    /// </summary>
    public interface IMesServicesChannel : IMesServices
    {
        /// <summary>
        /// returns true when this channel is currently shutting down. While shutting down this channel could not be used for communication.
        /// </summary>
        /// <returns></returns>
        Boolean isShutdown();

        /// <summary>
        /// starting up this channel. While starting up this channel could not be used for communication.
        /// </summary>
        void startup();

        /// <summary>
        /// initiate the shutdown of the channel.
        /// </summary>
        void shutdown();

        /// <summary>
        /// setting a name for this channel. Name could be used by java client as well.
        /// </summary>
        /// <param name="channelName"></param>
        void setChannelName(String channelName);

        /// <summary>
        /// returning the name of this channel.
        /// </summary>
        /// <returns></returns>
        String getChannelName();
    }

}