//-----------------------------------------------------------------------
// <copyright file="URLParamModel.cs" company="BTU/IIT">
//     Company copyright tag.
// </copyright>
// <author>stubbfel</author>
// <sience>17.06.2013</sience>
//----------------------------------------------------------------------
namespace CampusAppWPortalLib8.Model.Utility
{
    /// <summary>
    /// This class is a Model for the URLParameter like GET-Parameter
    /// </summary>
    public class UrlParamModel
    {
        #region Members

        /// <summary>
        /// Variable of the key
        /// </summary>
        protected readonly string key;

        #endregion

        #region Constructor

        /// <summary>
        /// Initializes a new instance of the <see cref="UrlParamModel" /> class.
        /// </summary>
        /// <param name="key">the key for the parameter</param>
        public UrlParamModel(string key)
        {
            this.key = key;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="UrlParamModel" /> class.
        /// </summary>
        /// <param name="key">the key for the parameter</param>>
        /// <param name="value">value of the parameter</param>
        public UrlParamModel(string key, string value)
        {
            this.key = key;
            this.Value = value;
        }
        #endregion

        #region Proberty

        /// <summary>
        ///  Gets or sets the value of the Parameter
        /// </summary>
        public string Value { get; set; }

        /// <summary>
        /// Gets the key of the parameter
        /// </summary>
        public string Key
        {
            get
            {
                return this.key;
            }
        }

        /// <summary>
        /// Gets the token, which indicate that the parameterList started
        /// </summary>
        public virtual string ParamToken
        {
            get
            {
                return "?";
            }
        }
        #endregion

        #region Methods

        /// <summary>
        /// Method check if the parameter is valid
        /// </summary>
        /// <returns>true if is it valid, otherwise false</returns>
        public virtual bool IsParamValid()
        {
            if (this.key == null || string.Empty.Equals(this.key) || string.Empty.Equals(this.Value))
            {
                return false;
            }

            return true;
        }

        /// <summary>
        /// Method return a formatted string like Key=Value
        /// </summary>
        /// <returns> return formatted string</returns>
        public override string ToString()
        {
            if (!this.IsParamValid())
            {
                return string.Empty;
            }

            return "&" + this.key + "=" + this.Value;
        }
        #endregion
    }
}