Componentes JSON&JS (Parte 10 de 12)

methods   

Es opcional y permite especificar los métodos "client-executed" que proporciona el control. Cada miembro del grupo identifica un método. El nombre de cada uno es el también el nombre del método, incluyendo su prefijo "$". Los elementos válidos para la definición de un método son:

• id

Es obligatorio, será el número (entero positivo) del método. Debe ser único dentro del contexto del control. Es utilizado internamente por Omnis.

• desc

Es obligatorio, y deberá consistir en un texto descriptivo del método. 

• type

Es obligatorio e indica el tipo de dato que retorna el método. ("integer", "boolean", "character" o "list")

• parameters

Es opcional. Consiste en una matriz que describe los parámetros del método. Cada miembro de la matriz es un parámetro con los siguientes atributos: 

• name

Es obligatorio y es el nombre del parámetro. Omnis insertará el carácter "p" al comienzo de este nombre.

• desc

Es obligatorio y deberá consistir en un texto descriptivo del parámetro. 

• type

Es obligatorio e indica el tipo de datos que admitirá el parámetro. ("integer", "character", "boolean" o "list").

• altered

Opcional. Deberá ser booleano. (por defecto "false") Si es "true", el parámetro se marcará como no-alterable.  

• optional 

Opcional. Deberá ser booleano. (por defecto "false"). Si es "true", el parámetro se marcará como opcional. 

 Ejemplo:

"methods": {

   "$mymethod1": { 

      "id": 1,

      "desc": "This is my method", 

      "type": "integer", "parameters": [

   {

      "name": "p1",

      "type": "character", 

      "altered": true,

      "desc": "The parameter p1"

   },

   {

      "name": "p2",

      "type": "integer",

      "desc": "The parameter p2", 

      "optional":true

    }

   ]

  }

}