/*
 * 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.Collections.Generic;
using JetBrains.Annotations;
using Nehta.VendorLibrary.CDA.Common.Enums;
using Nehta.VendorLibrary.Common;

namespace Nehta.VendorLibrary.CDA.SCSModel
{
    /// <summary>
    /// This interface contains the codable text translation for a codable text.
    /// </summary>
    public interface ICodableTranslation
    {
        /// <summary>
        /// Code
        /// </summary>
        [CanBeNull]
        string Code { get; set; }

        [CanBeNull]
        NullFlavour? NullFlavour { get; set; }

        [CanBeNull]
        bool HasCodeSystem { get; }

        [CanBeNull]
        string CodeSystemName { get; set; }

        [CanBeNull]
        string CodeSystemCode { get; set; }

        [CanBeNull]
        string CodeSystemVersion { get; set; }

        /// <summary>
        /// The dispaly name associated with the code
        /// </summary>
        [CanBeNull]
        string DisplayName { get; set; }

        /// <summary>
        /// A free text field that can be used in the absence of a code, code system and display name, 
        /// alternately it can be used to provide addational information
        /// </summary>
        [CanBeNull]
        string OriginalText { get; set; }

        /// <summary>
        /// This property returns the display name if it set, otherwise it defaults to the original text property
        /// </summary>
        [CanBeNull]
        string NarrativeText { get; }

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