Yahoo! Managed

' ******************************************************************************
' ** 
' **  Yahoo Finance Managed
' **  Written by Marius Häusler 2010
' **  It would be pleasant, if you contact me when you are using this code.
' **  Contact: YahooFinanceManaged@gmail.com
' **  Project Home: http://code.google.com/p/yahoo-finance-managed/
' **  
' ******************************************************************************
' **  
' **  Copyright 2010 Marius Häusler
' **  
' **  Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
' **  
' **  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.
' ** 
' ******************************************************************************


Namespace Finance

    ''' <summary>
    ''' Provides the description of a currency of YahooManaged.Finance.Currency.
    ''' </summary>
    ''' <remarks></remarks>
    Public Class CurrencyInfo
        Private mID As Currency = Currency.AED
        Private mDescription As String = String.Empty

        ''' <summary>
        ''' The currency ID.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property ID() As Currency
            Get
                Return mID
            End Get
            Set(ByVal value As Currency)
                mID = value
            End Set
        End Property
        ''' <summary>
        ''' The currency name/description.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property Description() As String
            Get
                Return mDescription
            End Get
            Set(ByVal value As String)
                mDescription = value
            End Set
        End Property

        ''' <summary>
        ''' Defaul constructor
        ''' </summary>
        ''' <remarks></remarks>
        Public Sub New()
        End Sub

        Public Overrides Function ToString() As String
            If Me.Description <> String.Empty Then
                Return Me.Description & " (" & Me.ID.ToString & ")"
            Else
                Return Me.ID.ToString
            End If
        End Function

    End Class

End Namespace