com.quantum.dxi.rest.vtl

Class SupportedLibraries

java.lang.Object

Base

com.quantum.dxi.rest.vtl.SupportedLibraries

public class SupportedLibraries
extends Base

The SupportedLibraries resource represents VTL library emulations supported on the system. The SupportedLibraries interface includes services for getting the list of libraries supported by the system.

The schema that defines the SupportedLibraries resource is defined below.

 
    <xs:element name="SupportedLibraries">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="SupportedLibrary" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="SupportedLibrary">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="ProductId" type="xs:string"/>
                <xs:element name="Description" type="xs:string"/>
        </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="SupportedLibraryColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="ProductId"/>
            <xs:enumeration value="Description"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
SupportedLibraries()

Method Summary

Modifier and Type	Method and Description
com.quantum.dxi.dao.types.SupportedLibraries	getSupportedLibraries(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString, java.lang.String errorType) GET /rest/SupportedLibraries
SupportedLibrary	getSupportedLibrary(javax.servlet.http.HttpServletRequest request, java.lang.String productId, java.lang.String errorType) GET /rest/SupportedLibraries/{productId}

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SupportedLibraries

public SupportedLibraries()

Method Detail

getSupportedLibraries

public com.quantum.dxi.dao.types.SupportedLibraries getSupportedLibraries(@Context
                                                                          javax.servlet.http.HttpServletRequest request,
                                                                          int start,
                                                                          int limit,
                                                                          java.lang.String sortColumn,
                                                                          java.lang.String sortDirection,
                                                                          java.lang.String filterString,
                                                                          java.lang.String errorType)

GET /rest/SupportedLibraries

Get the VTL library emulations supported on the system.

getSupportedLibraries supports the table query parameters. Column names for sorting and filtering are defined in <xs:simpleType name="SupportedLibraryColumnNameType">

Response Entity type: <xs:element name="SupportedLibraries">

Since:

1.1

getSupportedLibrary

public SupportedLibrary getSupportedLibrary(@Context
                                            javax.servlet.http.HttpServletRequest request,
                                            java.lang.String productId,
                                            java.lang.String errorType)

GET /rest/SupportedLibraries/{productId}

Get the VTL library emulation from the system identified by {productId}.

Response Entity type: <xs:element name="SupportedLibrary">

Since:

1.1