Siminov Hybrid Siminov Hybrid

  • API Docs for Version: 2.0

    • APIs

    Show:

    LibraryDescriptor Class

    Defined in: /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:52
    Module: Model

    Exposes methods to GET and SET Library Descriptor information as per define in LibraryDescriptor.xml file by application.

    Example:
                        
                            <!-- DESIGN OF LibraryDescriptor.xml -->
                        
                            <library-descriptor>
                        
                                <!-- General Properties Of Library -->
                        
                                <!-- Mandatory Field -->
                                <property name="name">name_of_library</property>
                        
                                <!-- Optional Field -->
                                <property name="description">description_of_library</property>
                        
                        
                        
                                <!-- Entity Descriptor Needed Under This Library Descriptor -->
                        
                                <!-- Optional Field -->
                                    <!-- Database Mappings -->
                                <entity-descriptors>
                                    <entity-descriptor>name_of_database_descriptor.full_path_of_database_mapping_descriptor_file</entity-descriptor>
                                </entity-descriptors>
                        
                        
                                <!-- Service Descriptors -->
                        
                                <!-- Optional Field -->
                                    <!-- Service Descriptor -->
                                <service-descriptors>
                                    <service-descriptor>full_path_of_service-descriptor_file</service-descriptor>
                                </service-descriptors>
                        
                        
                                <!-- Sync Descriptors -->
                        
                                <!-- Optional Field -->
                                    <!-- Sync Descriptor -->
                                <sync-descriptors>
                                    <sync-descriptor>full_path_of_sync_descriptor_file</sync-descriptor>
                                </sync-descriptors>
                        
                        
                                <!-- Adapter Descriptors -->
                        
                                <!-- Optional Field -->
                                    <!-- Adapter Descriptor -->
                                <adapter-descriptors>
                                    <adapter-descriptor>full_path_of_adapter_descriptor_file</adapter-descriptor>
                                </adapter-descriptors>
                        
                        
                            </library-descriptor>

    Methods

    addEntityDescriptorPath

    (
    • entityDescriptorPath
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:232

    Add entity path as per defined in DatabaseDescriptor.xml file.

        EXAMPLE:
                                                    <database-descriptor>
                                                        <entity-descriptors>
                                                            <entity-descriptor>Entity-Descriptors/Book.xml</entity-descriptor>
                                                            <entity-descriptor>Entity-Descriptors/Lession.xml</entity-descriptor>
                                                        </entity-descriptors>
                                                    </database-descriptor>

    Parameters:

    • entityDescriptorPath String

      Entity Descriptor Path.

    addProperty

    (
    • name
    • value
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:199

    Add Property in property pool.

    Parameters:

    • name String

      Name of Property.

    • value String

      value of Property.

    addServiceDescriptorPath

    (
    • serviceDescriptorPath
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:262

    Add service descriptor path

    Parameters:

    • serviceDescriptorPath String

      Service descriptor path

    containProperty

    (
    • name
    )
    Boolean

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:187

    Check whether Property exist or not.

    Parameters:

    • name String

      Name of Property.

    Returns:

    Boolean:

    true/false, TRUE if property exist, FALSE if property does not exist.

    getAdapterDescriptorPath

    (
    • adapterDescriptorPath
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:282

    Get adapter descriptor path

    Parameters:

    • adapterDescriptorPath String

      Adapter Descriptor Path

    getAdapterDescriptorPaths

    (
    • Adapter
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:272

    Get all adapter descriptor paths

    Parameters:

    • Adapter Array

      Descriptor Paths

    getDescription

    () String

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:143

    Get descriptor as per defined in LibraryDescriptor.xml

    Returns:

    String:

    Description of Library

    getEntityDescriptorPaths

    () Array

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:222

    Get all entity descriptor paths as per defined in DatabaseDescriptor.xml file.

    Returns:

    Array:

    It contain all entity paths.

    getName

    () String

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:123

    Get library name.

    Returns:

    String:

    Name of Library

    getProperties

    () Array

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:164

    Get all Properties defined in descriptor.

    Returns:

    Array:

    All Property Values.

    getProperty

    (
    • name
    )
    String

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:175

    Get Property based on name provided.

    Parameters:

    • name String

      Name of Property.

    Returns:

    String:

    Property value.

    getServiceDescriptorPaths

    () Array

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:252

    Get all service descriptor paths

    Returns:

    Array:

    Service Descriptor Paths

    removeProperty

    (
    • name
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:211

    Remove Property from property pool.

    Parameters:

    • name String

      Name of Property.

    setDescription

    (
    • descriptor
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:153

    Set description as per defined in LibraryDescritor.core.xml

    Parameters:

    • descriptor String

      Description of Library

    setName

    (
    • name
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/LibraryDescriptor.js:133

    Set library name as per defined in LibraryDescriptor.xml

    Parameters: