/*
  * The contents of this file are subject to the Mozilla Public
  * License Version 1.1 (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.mozilla.org/MPL/
  *
  * Software distributed under the License is distributed on an
  * "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express
  * or implied. See the License for the specific language governing
  * rights and limitations under the License.
  *
  *
  * The Original Code is .NET RASP toolkit.
  *
  * The Initial Developer of the Original Code is Accenture and Avanade.
  * Portions created by Accenture and Avanade are Copyright (C) 2007
  * Danish National IT and Telecom Agency (http://www.itst.dk). 
  * All Rights Reserved.
  *
  * Contributor(s):
  *   Gert Sylvest (gerts@avanade.com)
  *   Patrik Johansson (p.johansson@accenture.com)
  *   Michael Nielsen (michaelni@avanade.com)
  *   Dennis Søgaard (dennis.j.sogaard@accenture.com)
  *   Ramzi Fadel (ramzif@avanade.com)
  *   Mikkel Hippe Brun (mhb@itst.dk)
  *   Finn Hartmann Jordal (fhj@itst.dk)
  *   Christian Lanng (chl@itst.dk)
  *
  */
using System;
using System.Collections.Generic;
using System.Text;

namespace dk.gov.oiosi.oioublProfileLibrary {

    /// <summary>
    /// OIOUBL business entity interface
    /// </summary>
    public interface IOioublBusinessEntity {
        /// <summary>
        /// Gets the UddiId of the business entity
        /// </summary>
        string UddiId {get;}

        /// <summary>
        /// Gets the name of the businness entity
        /// </summary>
        string Name {get; set;}

        /// <summary>
        /// Gets the description of the business entity
        /// </summary>
        string Description {get;set;}

        /// <summary>
        /// Gets the cvr of the business entity
        /// </summary>
        string Cvr {get;set;}

        /// <summary>
        /// Activates the OIO UBL Profile for the Business Entity.
        /// The endpoint key used is the BusinessEntity CVR.
        /// </summary>
        /// <param name="oioublProfile">The OIO UBL profile to activate</param>
        /// <param name="endpointAddressList">The physical endpoint address to use</param>
        void ActivateOioublProfile(IOioublProfile oioublProfile, OioublEndpointAddressList endpointAddressList);

        /// <summary>
        /// Activates the OIO UBL Profile for the Business Entity
        /// </summary>
        /// <param name="oioublProfile">The OIO UBL profile to activate</param>
        /// <param name="endpointKey">The endpoint key type and value to use (eg. CVR, EAN)</param>
        /// <param name="endpointAddressList">The physical endpoint address to use</param>
        void ActivateOioublProfile(IOioublProfile oioublProfile, OioublEndpointKey endpointKey, OioublEndpointAddressList endpointAddressList);
        
        /// <summary>
        /// Deactivates the profile for the Business Entity
        /// </summary>
        /// <param name="oioublProfile"></param>
        void DeactivateOioublProfile(IOioublProfile oioublProfile);

        /// <summary>
        /// Looks whether the OIO UBL profile is activated for the Business Entity
        /// </summary>
        /// <param name="oioublProfile"></param>
        /// <returns></returns>
        bool HasOioublProfile(IOioublProfile oioublProfile);

        /// <summary>
        /// Clear all services of the business entity
        /// </summary>
        void ClearServices();

        /// <summary>
        /// Removes the BusinessEntity and related services and profiles from the registry
        /// </summary>
        void Delete();
    }
}
