VRegister
Última actualización
Última actualización
Los objetos de esta clase representan una ficha de una tabla.
Los register pueden ser creados:
Automáticamente por Velneo como theRegisterIn y theRegisterOut al inicio de un script lanzado desde uno o varios objetos Velneo con entrada o salida ficha.
Desde otro objeto en javascript como con la función readAt de la clase VRegisterList que devuelve un VRegister.
Dispone de funciones para gestionar los contenidos de los campos por identificador simple o compuesto y por número de campo. Además se pueden ver los contenidos previos de los campos, cuando se leyó la ficha.
También dispone de una funciones para obtener la subclase del tipo VTableInfo que nos da información api de la tabla y de sus campos, índices e históricos para ver las propiedades de estos objetos como por ejemplo el tipo de un campo, su identificador o su número de decimales.
Para edición tenemos funciones de alta, baja y modificación así como de control de errores.
Y al más puro estilo Velneo, las funciones de navegante.
Constructor
Inicialización
De Api de tabla
De contenido de campos por identificador
De contenido de campos por número de campo
De valor old de campos por identificador
De valor old de campos por número de campo
De modificación de campos por identificador
De modificación de campos por número de campo
Para campos de tipo objeto
De estado
De operaciones de disco
De navegante
De variables locales
De variables de sistema
Funciones varias
Errores de operaciones de base de datos
ErrorNone = 0
ErrorUnknown = 1
ErrorTransUnknown = 2
ErrorAddReg = 3
ErrorDeleteReg = 4
ErrorModifyReg = 5
ErrorRead = 6
ErrorReadLocking = 7
ErrorNullDir = 8
ErrorIndexOutOfRange = 9
ErrorRegNotInit = 10
SearchModes
SearchThis
SearchNext
SearchPrev
SearchThisOrNext
SearchThisOrPrev
SearchFirst
SearchLast
Constructor de VRegister.
Parámetros:
root: objeto VRoot, normalmente theRoot.
Asigna la tabla al objeto VRegister creado con el constructor. Devuelve true si ha podido asignar la tabla correctamente. Una vez ejecutada es equivalente a crear una cesta de la tabla.
Parámetros:
szIdRefTable: cadena que contiene el identificador referencia de la tabla.
contenidosIniciales: booleano que indica si se ejecutarán los contenidos iniciales al crearse el registro, por defecto vale true, así que debemos especificar false para evitar que se disparen al crearse el nuevo registro.
Devuelve un objeto VTableInfo de la tabla del registro.
Devuelve el resultado de realizar el cálculo del campo objeto fórmula.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Devuelve el contenido de un campo en función del tipo.
Esta función devuelve un objeto hora, que es propio de la API de Velneo. Por lo tanto, solamente podremos gestionar el dato retornado solamente en la API de Velneo (por ejemplo, leer el campo de un registro para luego asignarlo a otro registro), pero no en JavaScript estándar ya que en JavaScript no existe.
Por ejemplo, si queremos generar un JSON con los datos de un registro y uno de los campos es de tipo hora, usaremos la función fieldToString para que devuelva el dato como cadena, que sí es reconocible por JavaScript.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primero campo es el 0.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primero campo es el 0.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primero campo es el 0.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primero campo es el 0.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primero campo es el 0.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primero campo es el 0.
Devuelve el contenido de un campo en función del tipo.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primero campo es el 0.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador del campo.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador del campo.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador del campo.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador del campo.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador del campo.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador del campo.
No es funcional con campos objeto (recordemos que su contenido no se guarda en la tabla sino en un fichero adicional llamado contenedor), ya que no hay acceso directo a la información del contenedor, pues se encuentra en el ámbito de registro y no de ficha.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador del campo.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primer campo es 0.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primer campo es 0.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primer campo es 0.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primer campo es 0.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primer campo es 0.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primer campo es 0.
No es funcional con campos objeto (recordemos que su contenido no se guarda en la tabla sino en un fichero adicional llamado contenedor), ya que no hay acceso directo a la información del contenedor, pues se encuentra en el ámbito de registro y no de ficha.
Devuelve el contenido anterior a la modificación de un campo en función del tipo. El valor old es diferente al valor del campo si ha sido modificado pero aún se ha guardado la información en disco. La precisión en JavaScript de los números con decimales es la de tipo "double". El identificador de campo compuesto permite especificar campos de la tabla y de las enlazadas.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primer campo es 0.
Modifica el valor de un campo en función del tipo.
Parámetros:
szIDPrimarioCampo: cadena que contiene el identificador del campo.
szText: cadena de texto a asignar como valor del campo.
Modifica el valor de un campo en función del tipo. La precisión en JavaScript de los números con decimales es la de tipo "double".
Parámetros:
szIDPrimarioCampo: cadena que contiene el identificador del campo.
dValor: número decimal a asignar como valor del campo.
Modifica el valor de un campo en función del tipo.
Parámetros:
szIDPrimarioCampo: cadena que contiene el identificador del campo.
nValor: número entero a asignar como valor del campo.
Modifica el valor de un campo en función del tipo.
Parámetros:
szIDPrimarioCampo: cadena que contiene el identificador del campo.
tiempo: tiempo (fecha y hora) a asignar como valor del campo en formato ISO-8061 (AAAA-MM-DDThh:mm:ss,ssZ).
Modifica el valor de un campo en función del tipo.
Parámetros:
szIDPrimarioCampo: cadena que contiene el identificador del campo.
fecha: fecha a asignar como valor del campo en formato ISO-8061 (AAAA-MM-DD).
Modifica el valor de un campo en función del tipo.
Parámetros:
szIDPrimarioCampo: cadena que contiene el identificador del campo.
tiempo: tiempo a asignar como valor del campo en formato ISO-8061 (hh:mm:ss,ss).
Modifica el valor de un campo en función del tipo.
Parámetros:
szIDPrimarioCampo: cadena que contiene el identificador del campo.
bool: booleano a asignar como valor del campo.
Modifica el valor de un campo en función del tipo.
Parámetros:
szIDPrimarioCampo: cadena que contiene el identificador del campo.
bool: booleano a asignar como valor del campo.
Modifica el valor de un campo en función del tipo. La precisión en JavaScript de los números con decimales es la de tipo "double".
Parámetros:
nCampo: número que contiene la posición campo. El primer campo es 0.
dValor: número decimal a asignar como valor del campo.
Modifica el valor de un campo en función del tipo.
Parámetros:
nCampo: número que contiene la posición campo. El primer campo es 0.
nValor: número entero a asignar como valor del campo.
Modifica el valor de un campo en función del tipo.
Parámetros:
nCampo: número que contiene la posición campo. El primer campo es 0.
szText: cadena de texto a asignar como valor del campo.
Modifica el valor de un campo en función del tipo.
Parámetros:
nCampo: número que contiene la posición campo. El primer campo es 0.
tiempo: tiempo (fecha y hora) a asignar como valor del campo en formato ISO-8061 (AAAA-MM-DDThh:mm:ss,ss).
Modifica el valor de un campo en función del tipo.
Parámetros:
nCampo: número que contiene la posición campo. El primer campo es 0.
fecha: fecha a asignar como valor del campo en formato ISO-8061 (AAAA-MM-DD).
Modifica el valor de un campo en función del tipo.
Parámetros:
nCampo: número que contiene la posición campo. El primer campo es 0.
tiempo: tiempo a asignar como valor del campo en formato ISO-8061 (hh:mm:ss,ss).
Devuelve un objeto de la clase VByteArray con el contenido de un campo de tipo objeto. También puede utilizarse con campos que no sean de tipo objeto.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Devuelve un objeto de la clase VImage con el contenido de un campo de tipo objeto dibujo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Modifica el contenido de un campo de tipo objeto con el contenido de un objeto VByteArray. También se puede utilizar para campos que no sean de tipo objeto. El campo destino se especifica mediante su número de campo.
Parámetros:
nCampo: número que contiene la posición campo. El primer campo es 0.
baBuffer: buffer con el contenido del objeto VByteArray a grabar en el campo objeto.
Modifica el contenido de un campo de tipo objeto con el contenido de un objeto VByteArray. También se puede utilizar para campos que no sean de tipo objeto. El campo destino se especifica mediante su identificador.
Parámetros:
nCampo: número que contiene la posición campo. El primer campo es 0.
baBuffer: buffer con el contenido del objeto VByteArray a grabar en el campo objeto.
Modifica el contenido de un campo de tipo objeto dibujo con el contenido de un objeto VImage. El campo destino se especifica mediante su número de campo.
Parámetros:
nCampo: number que contiene la posición campo. El primer campo es 0.
image: contenido del objeto VImage a grabar en el campo de tipo objeto dibujo.
Modifica el contenido de un campo de tipo objeto dibujo con el contenido de un objeto VImage. El campo destino se especifica mediante su identificador.
Parámetros:
szIDPrimarioCampo: cadena que contiene el identificador del campo.
image: contenido del objeto VImage a grabar en el campo de tipo objeto dibujo.
Devuelve true si el registro existe.
Devuelve true si el campo está vacío.
Parámetros:
nCampo: número que contiene la posición del campo en la tabla. El primero campo es el 0.
Devuelve true si el campo está vacío.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Devuelve true si el contenido del campo ha sido modificado.
Parámetros:
nCampo: número que contiene la posición del campo. El primer campo es 0.
Devuelve true si el contenido del campo ha sido modificado.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Devuelve true si alguno de los campos del registros ha sido modificado.
Da del alta el registro en la base de datos.
Elimina el registro en la base de datos.
Elimina el registro en la base de datos sin deshacer las actualizaciones. Esta función se utiliza para eliminar registros históricos sin que al eliminarlos se desactualicen las tablas maestras donde han acumulado datos.
Devuelve el texto del mensaje de error.
Devuelve el número de error producido en la operación de base de datos.
Ver enum de errores de operaciones de base de datos.
Devuelve true si la operación de base de datos ha finalizado satisfactoriamente.
Modifica el registro en la base de datos.
Devuelve el primer registro que devuelve el índice que pasamos como parámetro.
Parámetros:
szIdIndice: cadena que contiene el identificador del índice.
Devuelve el último registro que devuelve el índice que pasamos como parámetro.
Parámetros:
szIdIndice: cadena que contiene el identificador del índice.
Devuelve el registro siguiente que devuelve el índice que pasamos como parámetro.
Parámetros:
szIdIndice: cadena que contiene el identificador del índice.
Devuelve el registro anterior que devuelve el índice que pasamos como parámetro.
Parámetros:
szIdIndice: cadena que contiene el identificador del índice.
Devuelve el registro que cargamos del índice que pasamos como parámetro.
Parámetros:
szIdIndice: cadena que contiene el identificador del índice.
aKeyPartsResol: array que contiene las resoluciones de cada una de las partes del índice.
searchMode: número que contiene el modo de búsqueda. Ver enum de searchModes.
Los modos "SearchThis", "SearchThisOrNext" y "SearchThisOrPrev" sólo son operativos correctamente con índices de tipo clave única, un índice de tipo Acepta repetidas, por ejemplo, no puede devolver un único registro para un valor dado en el índice.
Las funciones de escritura en disco (addRegister, modifyRegister, etc.) sobre tablas en memoria requiere abrir transacción para que las operaciones se reflejen en la tabla.
Devuelve una referencia a un objeto de la clase VRegisterList que se genera internamente con la lista de registros del enlace plural del registro actual. Equivale al comando cargar plurales y a navegar a histórico de uno.
Al ser una referencia a una lista de registros interna, una segunda ejecución de la función loadPlurals provocará que se destruya la referencia anterior y se cree otra nueva. Para guardar esta lista debemos crear un nuevo VRegisterList.
Este comando está optimizado de modo que se pasa la ficha al servidor para que la carga de sus plurales se realice en 3er plano, excepto en el caso de las tablas en memoria, que se hará en primer plano.
Parámetros:
szIDHistorico: cadena que contiene el identificador del plural.
Accede al registro maestro en modificación, bloqueándolo en la transacción en curso.
Parámetros:
szIDPrimarioCampo: cadena que contiene el identificador del campo puntero al maestro.
Accede al registro maestro en sólo lectura.
Parámetros:
szIDPrimarioCampo: cadena que contiene el identificador del campo puntero al maestro.
Devuelve el valor de una variable local en función del tipo.
Parámetros:
szID: cadena que contiene el identificador de la variable local.
Devuelve el valor de una variable local en función del tipo.
Parámetros:
szID: cadena que contiene el identificador de la variable local.
Devuelve el valor de una variable local en función del tipo.
Parámetros:
szID: cadena que contiene el identificador de la variable local.
Devuelve el valor de una variable local en función del tipo.
Parámetros:
szID: cadena que contiene el identificador de la variable local.
Devuelve el valor de una variable local en función del tipo.
Parámetros:
szID: cadena que contiene el identificador de la variable local.
Devuelve el valor de una variable local en función del tipo.
Parámetros:
szID: cadena que contiene el identificador de la variable local.