/*
 * Copyright 2011 NEHTA
 *
 * Licensed under the NEHTA Open Source (Apache) License; you may not use this
 * file except in compliance with the License. A copy of the License is in the
 * 'license.txt' file, which should be provided with this work.
 *
 * 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.
 */

using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using System.Xml;
using JetBrains.Annotations;
using Nehta.VendorLibrary.CDA.Common;
using Nehta.VendorLibrary.CDA.Common.Enums;
using Nehta.VendorLibrary.CDA.SCSModel.Common;
using Nehta.VendorLibrary.Common;

namespace Nehta.VendorLibrary.CDA.SCSModel
{
    /// <summary>
    /// The IParticipant interface encapsulates all the properties that CDA requires for a participant
    /// </summary>
    public interface ICustodian
    {
        /// <summary>
        /// This identifier is used to associated participants through the document
        /// </summary>
        [CanBeNull]
        Guid UniqueIdentifier { get; set; }

        /// <summary>
        /// The address of the Custodian
        /// </summary>
        [CanBeNull]
        [DataMember]
        IAddress Address { get; set; }

        /// <summary>
        /// A list of electronic communication detail objects, E.g. Telephone numbers, Email addresses etc
        /// </summary>
        [CanBeNull]
        [DataMember]
        ElectronicCommunicationDetail ElectronicCommunicationDetail { get; set; }

        /// <summary>
        /// The organisation name
        /// </summary>
        [CanBeNull]
        [DataMember]
        IOrganisationName Organisation { get; set; }

        /// <summary>
        /// Validates this Participiant
        /// </summary>
        /// <param name="path">The path to this object as a string</param>
        /// <param name="messages">the validation messages, these may be added to within this method</param>
        void Validate(string path, List<ValidationMessage> messages);
    }
}
