VRegister

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.
Funciones
Constructor
Retorno
Función
​
​VRegister( VRoot root)
Inicialización
Retorno
Función
Boolean
​setTable( String szIdRefTable, Boolean bContenidosIniciales )
De Api de tabla
Retorno
Función
​VTableInfo​
​tableInfo()
De contenido de campos por identificador
Retorno
Función
Variant
​calcDynamicFormula( String szIDCompuestoCampo )
Boolean
​fieldToBool( String szIDCompuestoCampo )
Date
​fieldToDate( String szIDCompuestoCampo )
DateTime
​fieldToDateTime( String szIDCompuestoCampo )
Number
​fieldToDouble( String szIDCompuestoCampo )
Number
​fieldToInt( String szIDCompuestoCampo )
String
​fieldToString( String szIDCompuestoCampo )
Time
​fieldToTime( String szIDCompuestoCampo )
De contenido de campos por número de campo
Retorno
Función
Boolean
​fieldToBool( Number nCampo )
Date
​fieldToDate( Number nCampo )
DateTime
​fieldToDateTime( Number nCampo )
Number
​fieldToDouble( Number nCampo )
Number
​fieldToInt( Number nCampo )
String
​fieldToString( Number nCampo )
Time
​fieldToTime( Number nCampo )
De valor old de campos por identificador
Retorno
Función
Boolean
​oldFieldToBool( String szIDPrimarioCampo )
Date
​oldFieldToDate( String szIDPrimarioCampo )
DateTime
​oldFieldToDateTime( String szIDPrimarioCampo )
Number
​oldFieldToDouble( String szIDPrimarioCampo )
Number
​oldFieldToInt( String szIDPrimarioCampo )
String
​oldFieldToString( String szIDPrimarioCampo )
Time
​oldFieldToTime( String szIDPrimarioCampo )
De valor old de campos por número de campo
Retorno
Función
Boolean
​oldFieldToBool( Number nCampo )
Date
​oldFieldToDate( Number nCampo )
DateTime
​oldFieldToDateTime( Number nCampo )
Number
​oldFieldToDouble( Number nCampo )
Number
​oldFieldToInt( Number nCampo )
String
​oldFieldToString( Number nCampo )
Time
​oldFieldToTime( Number nCampo )
De modificación de campos por identificador
Retorno
Función
void
​setField( String szIDPrimarioCampo, String szText )
void
​setField( String szIDPrimarioCampo, double dValor )
void
​setField( String szIDPrimarioCampo, int nValor )
void
​setField( String szIDPrimarioCampo, StringDateTime tiempo )
void
​setField( String szIDPrimarioCampo, StringDate fecha )
void
​setField( String szIDPrimarioCampo, StringTime tiempo )
void
​setField( String szIDPrimarioCampo, Boolean bool )
De modificación de campos por número de campo
Retorno
Función
void
​setField( Number nCampo, Boolean bool )
void
​setField( Number nCampo, double dValor)
void
​setField( Number nCampo, int nValor )
void
​setField( Number nCampo, String szText )
void
​setField( Number nCampo, StringDateTime tiempo )
void
​setField( Number nCampo, StringDate fecha )
void
​setField( Number nCampo, StringTime tiempo )
Para campos de tipo objeto
Retorno
Función
​VByteArray​
​fieldToByteArray( String szIDPrimarioCampo )
​VImage​
​fieldToImage( String szIDPrimarioCampo )
void
​setFieldByteArray( Number nCampo, VByteArray baBuffer )
void
​setFieldByteArray( String szIDPrimarioCampo, VByteArray baBuffer )
void
​setFieldImage( Number nCampo, VImage image )
void
​setFieldImage( String szIDPrimarioCampo, VImage image )
De estado
Retorno
Función
Boolean
​exist()
Boolean
​isFieldEmpty( Number nCampo )
Boolean
​isFieldEmpty( String szIDCompuestoCampo )
Boolean
​isFieldModified( Number nCampo )
Boolean
​isFieldModified( String szIDCompuestoCampo )
Boolean
​isModified()
De operaciones de disco
Retorno
Función
Boolean
​addRegister()
Boolean
​deleteRegister()
Boolean
​deleteRegisterWhithoutDeupdating()
String
​errorMessage()
Number
​errorNumber()
Boolean
​isOK()
Boolean
​modifyRegister()
Boolean
​readFirstRegister( String szIdIndice )
Boolean
​readLastRegister( String szIdIndice )
Boolean
​readNextRegister( String szIdIndice )
Boolean
​readPrevRegister( String szIdIndice )
Boolean
​readRegister( String szIdIndice, Array aKeyPartsResol, Number searchMode )
De navegante
Retorno
Función
​VRegisterList&
​loadPlurals( String szIDHistorico )
​VRegister​
​readLockingMaster( String szIDPrimarioCampo )
​VRegister​
​readMaster( String szIDPrimarioCampo )
De variables locales
Retorno
Función
Date
​varToDate( String szID )
DateTime
​varToDateTime( String szID )
Number
​varToDouble( String szID )
Number
​varToInt( String szID )
String
​varToString( String szID )
Time
​varToTime( String szID )
De variables de sistema
Retorno
Función
String
​clientCachePath()
Number
​currentPage()
Boolean
​isAdministrator()
Number
​lastPage()
Number
​listPos()
Number
​listSize()
String
​userName()
Funciones varias
Retorno
Función
Boolean
​copyFrom( VRegister registerOtro )
Boolean
​runProcess( String szIdRefProcess )
Enumeraciones
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
Documentación de funciones
Constructor
VRegister( VRoot root )
Constructor de VRegister.
Parámetros:
root: objeto VRoot, normalmente theRoot.
Inicialización
Boolean setTable( String szIdRefTable, Boolean bContenidosIniciales )
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.
Funciones de Api de tabla
VTableInfo tableInfo()
Devuelve un objeto VTableInfo de la tabla del registro.
Funciones de contenido de campos por identificador
Variant calcDynamicFormula( String szIDCompuestoCampo )
Devuelve el resultado de realizar el cálculo del campo objeto fórmula.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Boolean fieldToBool( String szIDCompuestoCampo )
Devuelve el contenido de un campo en función del tipo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Date fieldToDate( String szIDCompuestoCampo )
Devuelve el contenido de un campo en función del tipo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
DateTime fieldToDateTime( String szIDCompuestoCampo )
Devuelve el contenido de un campo en función del tipo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Number fieldToDouble( String szIDCompuestoCampo )
Devuelve el contenido de un campo en función del tipo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Number fieldToInt( String szIDCompuestoCampo )
Devuelve el contenido de un campo en función del tipo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
String fieldToString( String szIDCompuestoCampo )
Devuelve el contenido de un campo en función del tipo.
Parámetros:
szIDCompuestoCampo: cadena que contiene el identificador compuesto del campo.
Time fieldToTime( String szIDCompuestoCampo )
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.
Funciones de contenido de campos por número de campo
Boolean fieldToBool( Number nCampo )
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.
Date fieldToDate( Number nCampo )
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.
DateTime fieldToDateTime( Number nCampo )
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.
Number fieldToDouble( Number nCampo )
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.
Number fieldToInt( Number nCampo )
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.
String fieldToString( Number nCampo )
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.
Time fieldToTime( Number nCampo )
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.
Funciones de valor old de campos por identificador
Boolean oldFieldToBool( String szIDPrimarioCampo )
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.
Date oldFieldToDate( String szIDPrimarioCampo )
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.
DateTime oldFieldToDateTime( String szIDPrimarioCampo )
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.
Number oldFieldToDouble( String szIDPrimarioCampo )
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.
Number oldFieldToInt( String szIDPrimarioCampo )
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.
String oldFieldToString( String szIDPrimarioCampo )
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.
Time oldFieldToTime( String szIDPrimarioCampo )
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.
Funciones de valor old de campos por número de campo
Boolean oldFieldToBool( Number nCampo )
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.
Date oldFieldToDate( Number nCampo )
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.
DateTime oldFieldToDateTime( Number nCampo )
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.
Number oldFieldToDouble( Number nCampo )
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.
Number oldFieldToInt( Number nCampo )
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.
String oldFieldToString( Number nCampo )
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.
Time oldFieldToTime( Number nCampo )
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.
Funciones de modificación de campos por identificador
void setField( String szIDPrimarioCampo, String szText )
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.
void setField( String szIDPrimarioCampo, double dValor )
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.
void setField( String szIDPrimarioCampo, int nValor )
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.
void setField( String szIDPrimarioCampo, StringDateTime tiempo )
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).
void setField( String szIDPrimarioCampo, StringDate fecha )
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).
void setField( String szIDPrimarioCampo, StringTime tiempo )
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).
void setField( String szIDPrimarioCampo, Boolean bool )
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.
Funciones de modificación de campos por número de campo
void setField( Number nCampo, Boolean bool )
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.
void setField( Number nCampo, double dValor)
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.
void setField( Number nCampo, int nValor )
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.
void setField( Number nCampo, String szText )
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.
void setField( Number nCampo, StringDateTime tiempo )
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).
void setField( Number nCampo, StringDate fecha )
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).
void setField( Number nCampo, StringTime tiempo )
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).
Funciones para campos de tipo objeto
VByteArray fieldToByteArray( String szIDPrimarioCampo )
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.
VImage fieldToImage( String szIDPrimarioCampo )
Devuelve un objeto de la clase VImagae con el contenido de un campo de tipo objeto dibujo.
Parámetros:
Retorno	Función
Boolean	setTable( String szIdRefTable, Boolean bContenidosIniciales )
Retorno	Función
Variant	calcDynamicFormula( String szIDCompuestoCampo )
Boolean	fieldToBool( String szIDCompuestoCampo )
Date	fieldToDate( String szIDCompuestoCampo )
DateTime	fieldToDateTime( String szIDCompuestoCampo )
Number	fieldToDouble( String szIDCompuestoCampo )
Number	fieldToInt( String szIDCompuestoCampo )
String	fieldToString( String szIDCompuestoCampo )
Time	fieldToTime( String szIDCompuestoCampo )
Retorno	Función
void	setField( String szIDPrimarioCampo, String szText )
void	setField( String szIDPrimarioCampo, double dValor )
void	setField( String szIDPrimarioCampo, int nValor )
void	setField( String szIDPrimarioCampo, StringDateTime tiempo )
void	setField( String szIDPrimarioCampo, StringDate fecha )
void	setField( String szIDPrimarioCampo, StringTime tiempo )
void	setField( String szIDPrimarioCampo, Boolean bool )
Retorno	Función
VByteArray	fieldToByteArray( String szIDPrimarioCampo )
VImage	fieldToImage( String szIDPrimarioCampo )
void	setFieldByteArray( Number nCampo, VByteArray baBuffer )
void	setFieldByteArray( String szIDPrimarioCampo, VByteArray baBuffer )
void	setFieldImage( Number nCampo, VImage image )
void	setFieldImage( String szIDPrimarioCampo, VImage image )
Retorno	Función
VRegisterList&	loadPlurals( String szIDHistorico )
VRegister	readLockingMaster( String szIDPrimarioCampo )
VRegister	readMaster( String szIDPrimarioCampo )