Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Variable

Variable class

Hierarchy

  • Item
    • Variable

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Variable(__namedParameters?: VariableParameters): Variable

Properties

Optional codelist

codelist: string

CDISC Library attribute. C-Code of the codelist.

Optional codelistHref

codelistHref: string

CDISC Library attribute.

Optional core

core: string

CDISC Library attribute.

coreObject

coreObject: CoreObject

CLA Wrapper attribute. Object used to send API requests and store technical information. Must be the same object for all classes within an instance of a CdiscLibrary class.

Optional describedValueDomain

describedValueDomain: string

CDISC Library attribute.

Optional description

description: string

CDISC Library attribute.

Optional href

href: string

CDISC Library API endpoint.

Optional id

id: string

Optional label

label: string

CDISC Library attribute.

Optional name

name: string

CDISC Library attribute.

Optional ordinal

ordinal: string

CDISC Library attribute.

Optional role

role: string

CDISC Library attribute.

Optional roleDescription

roleDescription: string

CDISC Library attribute. In most cases identical to role, but in some cases contains further explanation of the role attribute.

Optional simpleDatatype

simpleDatatype: string

CDISC Library attribute.

Optional type

type: string

CDISC Library attribute. Value of the _links.self.type.

Optional valueList

valueList: string[]

CDISC Library attribute.

Methods

getCodeList

  • getCodeList(ctVer: string): Promise<CodeList>

  • Get a Codelist object corresponding to the codelist used by the item.

    Parameters

    • ctVer: string

    Returns Promise<CodeList>

    Instance of the CodeList class if item has a codelist.

getRawResponse

  • getRawResponse(href?: string): Promise<object>

  • Get raw API response

    Parameters

    • Optional href: string

      CDISC Library API endpoint. If not specified, href attribute of the object is used.

    Returns Promise<object>

    Returns a JSON response if the request was successfull, otherwise returns undefined.

load

  • load(href?: string): Promise<boolean>

  • Load object from the CDISC Library

    Parameters

    • Optional href: string

      CDISC Library API endpoint. If not specified, href attribute of the object is used.

    Returns Promise<boolean>

    Returns true in the object was successfully loaded, false otherwise

parseItemResponse

  • parseItemResponse(itemRaw: any): void

  • Parse API response to item.

    Parameters

    • itemRaw: any

      Raw CDISC API response.

    Returns void

parseResponse

  • parseResponse(vRaw: any): void

  • Parse API response to variable

    Parameters

    • vRaw: any

      Raw CDISC API response

    Returns void

toSimpleObject

  • toSimpleObject(): any

  • Convert class to a simple object, removes methods and technical elements (e.g., coreObject).

    Returns any

    A new object

Generated using TypeDoc