Liquid XML Data Binder 2020
In This Topic
    SearchResponse.cls
    In This Topic
    VERSION 1.0 CLASS
    BEGIN
      MultiUse = -1  'True
      Persistable = 0  'NotPersistable
      DataBindingBehavior = 0  'vbNone
      DataSourceBehavior  = 0  'vbNone
      MTSTransactionMode  = 0  'NotAnMTSObject
    END
    Attribute VB_Name = "SearchResponse"
    Attribute VB_GlobalNameSpace = False
    Attribute VB_Creatable = True
    Attribute VB_PredeclaredId = False
    Attribute VB_Exposed = True
    Option Explicit
    '**********************************************************************************************
    '* Copyright (c) 2001-2020 Liquid Technologies Limited. All rights reserved.
    '* See www.liquid-technologies.com for product details.
    '*
    '* Please see products End User License Agreement for distribution permissions.
    '*
    '* WARNING: THIS FILE IS GENERATED
    '* Changes made outside of ##HAND_CODED_BLOCK_START blocks will be overwritten
    '*
    '* Generation  :  by Liquid XML Data Binder 17.0.1.9233
    '* Using Schema: MusicStore.xsd
    '**********************************************************************************************
    Private m_ElementName As String
    Private m_validElement As String
    Private mvarResult As MusicStoreLib.Result   
    Private mvarError As MusicStoreLib.Error_   
    ' ##HAND_CODED_BLOCK_START ID="Additional Variable Declarations"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
    
    ' Add Additional Variable Declarations...
    
    ' ##HAND_CODED_BLOCK_END ID="Additional Variable Declarations"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
    
    Implements LtXmlComLib18.XmlObjectBase
    Implements LtXmlComLib18.XmlGeneratedClass
    
    ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
    ''''''''''''''''''''''''''''''''''''''''' Properties '''''''''''''''''''''''''''''''''''''''''
    ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
    
    Public Property Get ElementName() As String
        ElementName = m_elementName
    End Property
    
    ' Summary:
    '       Represents an optional Element in the XML document
    '       
    ' Remarks:
    '        
    '       This property is represented as an Element in the XML. 
    '       It is optional, initially it is null. 
    '       Only one Element within this class may be set at a time, setting this property when another element is already set will raise an exception. setting this property to null will allow another element to be selected 
    Public Property Get Result As MusicStoreLib.Result 
        Set Result = mvarResult  
    End Property
    Public Property Set Result(ByVal value As MusicStoreLib.Result)
        ' Ensure only on element is populated at a time
        ClearChoice "Result" ' remove selection
        if value is Nothing then
            Set mvarResult = Nothing
        else
            CastToXmlObjectBase(value).PrivateSetElementName "Result"
    '       LtXmlComLib18.XmlObjectBaseHelper.Throw_IfElementNameDiffers value, "Result"
            Set mvarResult = value
        End If
    End Property
            
    ' Summary:
    '       Represents an optional Element in the XML document
    '       
    ' Remarks:
    '        
    '       This property is represented as an Element in the XML. 
    '       It is optional, initially it is null. 
    '       Only one Element within this class may be set at a time, setting this property when another element is already set will raise an exception. setting this property to null will allow another element to be selected 
    Public Property Get Error_ As MusicStoreLib.Error_ 
        Set Error_ = mvarError  
    End Property
    Public Property Set Error_(ByVal value As MusicStoreLib.Error_)
        ' Ensure only on element is populated at a time
        ClearChoice "Error_" ' remove selection
        if value is Nothing then
            Set mvarError = Nothing
        else
            CastToXmlObjectBase(value).PrivateSetElementName "Error"
    '       LtXmlComLib18.XmlObjectBaseHelper.Throw_IfElementNameDiffers value, "Error"
            Set mvarError = value
        End If
    End Property
            
        
    Public Property Get ChoiceSelectedElement As String 
        ChoiceSelectedElement = m_validElement
    End Property
    friend Property Let ChoiceSelectedElement (ByVal value As String)
        m_validElement = value
    End Property
    
    
    ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
    ''''''''''''''''''''''''''''''''''' Standard Methods '''''''''''''''''''''''''''''''''''''''''
    ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
    
    Public Sub ToXmlFile(ByVal FileName As String, Optional includeDocHeader As Boolean = True, Optional formatting As LtXmlComLib18.XmlFormatting = LtXmlComLib18.XmlFormatting_Indented, Optional encoding As LtXmlComLib18.XmlEncoding = LtXmlComLib18.XmlEncoding_UTF8, Optional EOL As LtXmlComLib18.EOLType = LtXmlComLib18.EOLType.EOLType_CRLF, Optional context As LtXmlComLib18.XmlSerializationContext = Nothing)
        RegisterProduct
        LtXmlComLib18.XmlObjectBaseHelper.ToXmlFile Me, FileName, includeDocHeader, formatting, encoding, EOL, context
    End Sub
    Public Function ToXml(Optional includeDocHeader As Boolean = True, Optional formatting As LtXmlComLib18.XmlFormatting = LtXmlComLib18.XmlFormatting_Indented, Optional EOL As LtXmlComLib18.EOLType = LtXmlComLib18.EOLType.EOLType_LF, Optional context As LtXmlComLib18.XmlSerializationContext = Nothing) As String
        RegisterProduct
        ToXml = LtXmlComLib18.XmlObjectBaseHelper.ToXml(Me, includeDocHeader, formatting, EOL, context)
    End Function
    Public Function ToXmlStream(Optional includeDocHeader As Boolean = True, Optional formatting As LtXmlComLib18.XmlFormatting = LtXmlComLib18.XmlFormatting_Indented, Optional encoding As LtXmlComLib18.XmlEncoding = LtXmlComLib18.XmlEncoding_UTF8, Optional EOL As LtXmlComLib18.EOLType = LtXmlComLib18.EOLType.EOLType_LF, Optional context As LtXmlComLib18.XmlSerializationContext = Nothing) As Variant
        RegisterProduct
        ToXmlStream = LtXmlComLib18.XmlObjectBaseHelper.ToXmlStream(Me, includeDocHeader, formatting, encoding, EOL, context)
    End Function
    Public Sub FromXml(ByVal xmlIn As String, Optional context As LtXmlComLib18.XmlSerializationContext = Nothing)
        RegisterProduct
        LtXmlComLib18.XmlObjectBaseHelper.FromXml Me, xmlIn, context
    End Sub
    Public Sub FromXmlFile(ByVal FileName As String, Optional context As LtXmlComLib18.XmlSerializationContext = Nothing)
        RegisterProduct
        LtXmlComLib18.XmlObjectBaseHelper.FromXmlFile Me, FileName, context
    End Sub
    
    ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
    '''''''''''''''''''''''''''''''''''' Private Methods  ''''''''''''''''''''''''''''''''''''''''
    ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
    
    ' Summary:
    '       Constructor for SearchResponse
    ' Remarks:
    '       The class is created with all the mandatory fields populated with the
    '       default data.  
    '       All Collection object are created. 
    '           However any 1-n relationships (these are represented as collections) are
    '       empty. To comply with the schema these must be populated before the xml
    '       obtained from ToXml is valid against the schema MusicStore.xsd 
    Private Sub Class_Initialize()
        m_elementName = "SearchResponse"
        XmlGeneratedClass_Init
    End Sub
    
    ' Summary:
    '       Selects the given element as the selected choice
    Private Sub ClearChoice(ByVal SelectedElement as String)
        Set mvarResult           = Nothing
        Set mvarError           = Nothing
    
        m_validElement = selectedElement
    End Sub
    
    
    ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
    '''''''''''''''''''''''''''' Implementation of XmlObjectBase '''''''''''''''''''''''''''''''''
    ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
    
    Private Sub XmlObjectBase_PrivateSetElementName(ByVal vNewValue As String)
        m_ElementName = vNewValue
    End Sub
    
    Private Property Get XmlObjectBase_ElementName() As String
        XmlObjectBase_ElementName = m_ElementName
    End Property
    
    Private Property Get XmlObjectBase_TargetNamespace() As String
        XmlObjectBase_TargetNamespace = ""
    End Property
    
    Private Function XmlObjectBase_IsSuitableSubstitution(ByVal InterfaceName As String) As Boolean
        XmlObjectBase_IsSuitableSubstitution = false
        if InterfaceName = "SearchResponse" _
            then XmlObjectBase_IsSuitableSubstitution = true
    End Function
    
    Private Property Get XmlObjectBase_Namespace() As String
        XmlObjectBase_Namespace = ""
    End Property
    
    Private Function XmlObjectBase_FromXmlInt(ByVal XMLParent As MSXML2.IXMLDOMElement, ByVal XMLChild As MSXML2.IXMLDOMElement, ByVal context As LtXmlComLib18.XmlSerializationContext, ByVal isOptionalChoice As Boolean) As MSXML2.IXMLDOMElement
        Set XmlObjectBase_FromXmlInt = XmlGeneratedClassHelper.FromXml(Me, XMLParent, XMLChild, context, isOptionalChoice)
    End Function
    Private Sub XmlObjectBase_ToXmlInt(ByVal xmlOut As LtXmlComLib18.XmlTextWriter, ByVal bRegisterNamespaces As Boolean, ByVal NamespaceUri As String, ByVal context As LtXmlComLib18.XmlSerializationContext, ByVal isOptionalChoice As Boolean)
        XmlGeneratedClassHelper.ToXml Me, xmlOut, bRegisterNamespaces, NamespaceUri, context, isOptionalChoice
    End Sub
    Private Sub XmlObjectBase_AttributesToXmlInt(ByVal xmlOut As LtXmlComLib18.XmlTextWriter, ByVal context As LtXmlComLib18.XmlSerializationContext)
        XmlGeneratedClassHelper.AttributesToXml Me, xmlOut, context
    End Sub
    
    ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
    '''''''''''''''''''''''''' Implementation of XmlGeneratedClass '''''''''''''''''''''''''''''''
    ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
    
    ' Summary:
    '       Initializes the class
    ' Remarks:
    '       The Creates all the mandatory fields (populated with the default data) 
    '       All Collection object are created.
    '       However any 1-n relationships (these are represented as collections) are
    '       empty. To comply with the schema these must be populated before the xml
    '       obtained from ToXml is valid against the schema MusicStore.xsd.
    Private Sub XmlGeneratedClass_Init()
        Set mvarResult = Nothing
        Set mvarError = Nothing
        
        m_validElement = ""
    
    
    
        ' Force Init ClassInfo
        Dim classInfo As LtXmlComLib18.ClassInfo
        Set classInfo = XmlGeneratedClass_ClassInfo
    
    ' ##HAND_CODED_BLOCK_START ID="Additional Inits"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
    
    ' Add Additional Init Settings...
    
    ' ##HAND_CODED_BLOCK_END ID="Additional Inits"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
    
    End Sub 
    
    Private Property Get XmlGeneratedClass_ClassInfo() As LtXmlComLib18.ClassInfo
        If g_ClsDataSearchResponse Is Nothing Then
            Set g_ClsDataSearchResponse = New LtXmlComLib18.ClassInfo
            
            g_ClsDataSearchResponse.GroupType = LtXmlComLib18.XmlGroupType.Choice
            g_ClsDataSearchResponse.ElementType = LtXmlComLib18.XmlElementType.Element
            g_ClsDataSearchResponse.ElementName = "SearchResponse"
            g_ClsDataSearchResponse.ElementNamespaceURI = ""
            g_ClsDataSearchResponse.FromXmlFailIfAttributeUnknown = true
            g_ClsDataSearchResponse.IsClassDerived = false
            g_ClsDataSearchResponse.PrimitiveDataType = LtXmlComLib18.XmlDataType.type_none
            g_ClsDataSearchResponse.PrimitiveFormatOverride = ""
            g_ClsDataSearchResponse.OutputPrimitiveClassAsTextProperty = False
            Set g_ClsDataSearchResponse.ClassFactory = General.CF
            
            g_ClsDataSearchResponse.AddElmChoiceClsOpt "Result", "", "Result", LtXmlComLib18.XmlElementType.Element, ClsName_Result
            g_ClsDataSearchResponse.AddElmChoiceClsOpt "Error", "", "Error_", LtXmlComLib18.XmlElementType.Element, ClsName_Error_
        End If
        Set XmlGeneratedClass_ClassInfo = g_ClsDataSearchResponse
    End Property
    
    ' ##HAND_CODED_BLOCK_START ID="Additional Methods/Properties"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
    
    ' Add Additional Methods/Properties Here...
    
    ' ##HAND_CODED_BLOCK_END ID="Additional Methods/Properties"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS