Nombre de la Categoría: > API'S

DataManipulation WebService

Web Service SOAP que permite manipular la información contenida en Base de Datos Web de DANA.

  • Acceso

  Protocolo   URL
 HTTPS
Web Service
https://ws.danaconnect.com:18181/danaconnect/webDB/dataManipulationWebServicev2
Definición del Web Service
https://ws.danaconnect.com:18181/danaconnect/webDB/dataManipulationWebServicev2?wsdl

 

Se recomienda utilizar el protocolo HTTPS.

 

  • ¿Cómo empezar a utilizar el Web Service?

  1. La compañía que va a utilizar el Web Service debe estar autorizada para hacerlo.
  2. Se debe crear un usuario con el perfil apropiado que será utilizado por el sistema que consume el Web Service, para más información véase Perfil.
  3. Se debe otorgar los permisos necesarios al usuario para realizar la operación en las tablas deseadas, para más información véase Permisos.

 

  • Métodos

1.select

Realiza una consulta en una tabla de Bases de Datos Web.

StringMap[] select(String idCompany,
String login
String password,
String query,
int start)

 

Detalle de método select

Realiza una consulta en una tabla de Base de Datos Web.

Detalle

El query corresponden a la cláusula from en adelante de una sentencia select de sql y se emplea su sintaxis; para referenciar una tabla o una columna se debe emplear el código lógico de esta y debe estar entre corchetes.
La consulta va a retornar todos los campos de cada una de las tablas indicadas en la cláusula from de la consulta.

Ejemplo de query

FROM [PROYECTO] WHERE [PROYECTO_ANODELPROYECTO] = '2008' AND
[PROYECTO_ESTATUSDEPROYECTO] = '3'
GROUP BY [PROYECTO_UID] ORDER BY [PROYECTO_CODIGO] ASC
LIMIT 0,20

Limitaciones

  • El sistema distingue entre mayúsculas y minúsculas en el código lógico de las tablas y columnas, por lo que se debe utilizar la correcta capitalización al referenciar a tablas y columnas.
  • No están soportados los subquery (select dentro de la operación).
  • No está soportado incluir tras operaciones select dentro del query.

Sintaxis

public StringMap[] select(String idCompany,
String login,
String password,
String query,
int start)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidQueryException,
InvalidCompanyException

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

query Query de consulta de los registros.

start Registro de inicio a consultar, el conjunto resultante es desde el valor de start hasta los próximos 100 registros.

Valor devuelto

Arreglo con cada registro resultante de la consulta, cada entrada del arreglo corresponde a un objeto que contiene un diccionario con el valor de todas las columnas del registro, la clave es el código lógico de la columna y el valor es el valor de la columna.

 

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un select. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso para consultar registros de la tabla,
  • La tabla no tiene columnas,
  • Al menos una de las columnas no existe.

InvalidQueryException – Query inválido, esto puede ocurrir porque es nulo o vacío o porque existe un error de sintaxis.


InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.



2.selectById

Consulta todas las columnas de un registro en una tabla de Base de Datos Web dado su UID.

StringMap selectById(String idCompany,
String login,
String password,
String tableCode,
int uid)

 

Detalle de método selectById


Consulta todas las columnas de un registro en una tabla de Base de Datos Web dado su UID.

Sintaxis

public StringMap selectById(String idCompany,
String login,
String password,
String tableCode,
int uid)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidCompanyException

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

tableCode Código lógico de la tabla en la cual se va a ejecutar la operación.

uid Identificador del registro a ser consultado.

 

Valor devuelto

Objeto que contiene un diccionario con el valor de todas las columnas del registro, la clave es el código lógico de la columna y el valor es el valor de la columna.

 

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un select. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso para consultar registros de la tabla,
  • La tabla no tiene columnas.

InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.



3.relatedSelect

Consulta todas las columnas de un registro en una tabla de Base de Datos Web relacionada por un campo distinto al UID.

StringMap[] relatedSelect(String idCompany,
String login,
String password,
String query,
int start,
boolean relatedValue)

 

Detalle de método relatedSelect

Consulta todas las columnas de un registro en una tabla de Base de Datos Web relacionada por un campo distinto al UID.

Detalle

Si el query debe evaluar condiciones, el valor de la condición se encierra entre llaves, por ejemplo [FIRST_NAME]={‘Pablo’}. Si el valor es un String, debe encerrarse entre comillas simples dentro de los corchetes.

Ejemplo de condición

[PROYECTO_NRO] = {1111} AND [PROYECTO_NOMBRE] = {'Proyecto Inicial'}

Sintaxis

public StringMap[] relatedSelect(String idCompany,
String login,
String password,
String query,
int start,
boolean relatedValue)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidQueryException,
InvalidCompanyException

 

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

query Query de consulta de los registros.

start Registro de inicio a consultar, el conjunto resultante es desde el valor de start hasta los próximos 100 registros.

relatedValue Se asigna el valor de verdadero si la tabla está relacionadap or un campo distinto al UID.

 

Valor devuelto

Arreglo con cada registro resultante de la consulta, cada entrada del arreglo corresponde a un objeto que contiene un diccionario con el valor de todas las columnas del registro, la clave es el código lógico de la columna y el valor es el valor de la columna.

 

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un select. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso para consultar registros de la tabla,
  • La tabla no tiene columnas.

InvalidQueryException – Query inválido, esto puede ocurrir porque es nulo o vacío o porque existe un error de sintaxis.


InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.



4.insert

Inserta un registro en una tabla de Base de Datos Web.

int insert(String idCompany,
String login,
String password,
String tableCode,
StringMap values)

Detalle de método insert


Inserta un registro en una tabla de Base de Datos Web.
Sintaxis

public int insert(String idCompany,
String login,
String password,
String tableCode,
StringMap values)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidCompanyException

 

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

tableCode Código lógico de la tabla en la cual se va a ejecutar la operación.

values Diccionario con los valores del registro a insertar, la clave es el código lógico de la columna y el valor es el valor que va a recibir la columna.

 

Valor devuelto

UID o identificador del registro insertado.

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un insert. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso de insertar registros en la tabla,
  • La tabla no tiene columnas,
  • No se indicaron columnas (el diccionario es nulo o vacío),
  • Al menos una de las columnas no existe.

InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.



5.relatedInsert

Inserta un registro en una tabla de Base de Datos Web relacionada por un campo distinto al UID.

int relatedInsert(String idCompany,
String login,
String password,
String tableCode,
StringMap values,
boolean relatedValue)

Detalle de método relatedInsert

Inserta un registro en una tabla de Base de Datos Web relacionada por un campo distinto al UID.

 

Sintaxis

public int relatedInsert(String idCompany,
String login,
String password,
String tableCode,
StringMap values,
boolean relatedValue)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidCompanyException

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

tableCode Código lógico de la tabla en la cual se va a ejecutar la operación.

values Diccionario con los valores de las columnas a actualizar en el registro, la clave es el código lógico de la columna y el valor es el valor que va a recibir la columna.

relatedValue Se asigna el valor de verdadero si la tabla está relacionadap or un campo distinto al UID.

 

Valor devuelto

UID o identificador del registro insertado.

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un update. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso de actualizar registros en la tabla,
  • La tabla no tiene columnas,
  • No se indicaron columnas (el diccionario es nulo o vacío),
  • Al menos una de las columnas no existe.

InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.



6.update

Actualiza uno o varios registros de una tabla de Base de Datos Web siempre y cuando cumplan la condición dada.

int update(String idCompany,
String login,
String password,
String tableCode,
String conditions,
StringMap values)

Detalle de método update

Actualiza uno o varios registros de una tabla de Base de Datos Web siempre y cuando cumplan la condición dada.

 

Detalle
Las condiciones corresponden a la cláusula where de una sentencia sql y se emplea su sintaxis; para referenciar una tabla o una columna se debe emplear el código lógico de esta y debe estar entre corchetes.

 

Ejemplo de condición

[PARTICIPANTE_NOMBRE] = 'Pedro' AND [PARTICIPANTE_APELLIDO] = 'Perez'

 

Limitaciones

  • El sistema distingue entre mayúsculas y minúsculas en el código lógico de las tablas y columnas, por lo que se debe utilizar la correcta capitalización al referenciar a tablas y columnas.
  • En la condición solo se pueden utilizar columnas pertenecientes a la tabla indicada por argumento, si se trata de utilizar miembros de otras tablas el sistemas no los considerará válidos.
  • No están soportados los subquery (select dentro de la operación).

 

Sintaxis

public int update(String idCompany,
String login,
String password,
String tableCode,
String conditions,
StringMap values)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidQueryException,
InvalidCompanyException

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

tableCode Código lógico de la tabla en la cual se va a ejecutar la operación.

conditions Condición que deben cuamplir los registros a actualizar.

values Diccionario con los valores de las columnas a actualizar en el(los) registro(s), la clave es el código lógico de la columna y el valor es el valor que va a recibir la columna.

 

Valor devuelto

Cantidad de registros afectados, cero si no se actualizó ningún registro.

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un update. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso de actualizar registros en la tabla,
  • La tabla no tiene columnas,
  • No se indicaron columnas (el diccionario es nulo o vacío),
  • Al menos una de las columnas no existe (en el diccionario o en el query).

InvalidQueryException – Query inválido, esto puede ocurrir porque es nulo o vacío o porque existe un error de sintaxis.


InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.


7.updateById

Actualiza un registro de una tabla de Base de Datos Web dado su UID.

int updateById(String idCompany,
String login,
String password,
String tableCode,
int uid,
StringMap values)

Detalle de método updateById


Actualiza un registro de una tabla de Base de Datos Web dado su UID.

Detalle

Las condiciones corresponden a la cláusula where de una sentencia sql y se emplea su sintaxis; para referenciar una tabla o una columna se debe emplear el código lógico de esta y debe estar entre corchetes.

Ejemplo de condición

[UID] = '11'

Limitaciones

  • El sistema distingue entre mayúsculas y minúsculas en el código lógico de las tablas y columnas, por lo que se debe utilizar la correcta capitalización al referenciar a tablas y columnas.
  • En la condición solo se pueden utilizar columnas pertenecientes a la tabla indicada por argumento, si se trata de utilizar miembros de otras tablas el sistemas no los considerará válidos.
  • No están soportados los subquery (select dentro de la operación).

Sintaxis

public int updateById(String idCompany,
String login,
String password,
String tableCode,
int uid,
StringMap values)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidCompanyException

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

tableCode Código lógico de la tabla en la cual se va a ejecutar la operación.

uid Valor UID del registro a actualizar.

values Diccionario con los valores de las columnas a actualizar en el(los) registro(s), la clave es el código lógico de la columna y el valor es el valor que va a recibir la columna.

 

Valor devuelto

Cantidad de registros afectados, cero si no se actualizó ningún registro.

 

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un update. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso de actualizar registros en la tabla,
  • La tabla no tiene columnas,
  • No se indicaron columnas (el diccionario es nulo o vacío),
  • Al menos una de las columnas no existe (en el diccionario o en el query).

InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.


8.relatedUpdate

Actualiza un campo en una tabla de Base de Datos Web relacionada por un campo distinto al UID.

int relatedUpdate(String idCompany,
String login,
String password,
String tableCode,
String conditions,
StringMap values,
boolean relatedValue)

Detalle de método relatedUpdate


Actualiza un registro en una tabla de Base de Datos Web relacionada por un campo distinto al UID.

Detalle
Si el query debe evaluar condiciones, el valor de la condición se encierra entre llaves, por ejemplo [FIRST_NAME]={‘Pablo’}. Si el valor es un String, debe encerrarse entre comillas simples dentro de los corchetes.

Ejemplo de condición

[PROYECTO_NRO] = {1111} AND [PROYECTO_NOMBRE] = {'Proyecto Inicial'}

Limitaciones

  • El sistema distingue entre mayúsculas y minúsculas en el código lógico de las tablas y columnas, por lo que se debe utilizar la correcta capitalización al referenciar a tablas y columnas.
  • En la condición solo se pueden utilizar columnas pertenecientes a la tabla indicada por argumento, si se trata de utilizar miembros de otras tablas el sistemas no los considerará válidos.
  • No están soportados los subquery (select dentro de la operación).

Sintaxis

public int relatedUpdate(String idCompany,
String login,
String password,
String tableCode,
String conditions,
StringMap values,
boolean relatedValue)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidQueryException,
InvalidCompanyException

 

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

tableCode Código lógico de la tabla en la cual se va a ejecutar la operación.
conditions Condición que deben cuamplir los registros a actualizar.

values Diccionario con los valores de las columnas a actualizar en el(los) registro(s), la clave es el código lógico de la columna y el valor es el valor que va a recibir la columna.

relatedValue Se asigna el valor de verdadero si la tabla está relacionadap or un campo distinto al UID.

 

Valor devuelto

Cantidad de registros afectados, cero si no se actualizó ningún registro.

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un update. Esto puede ocurrir porque:

  • la tabla indicada no existe,
  • no se indicó la tabla (es nulo o vacío),
  • el usuario no tiene permiso de actualizar registros en la tabla,
  • la tabla no tiene columnas,
  • no se indicaron columnas (el diccionario es nulo o vacío),
  • al menos una de las columnas no existe (en el diccionario o en el query).

InvalidQueryException – Query inválido, esto puede ocurrir porque es nulo o vacío o porque existe un error de sintaxis.

InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.


9.delete

Elimina uno o varios registros de una tabla de Base de Datos Web siempre y cuando cumplan la condición dada.

int delete(String idCompany,
String login,
String password,
String tableCode,
String conditions)

Detalle de método delete

Elimina uno o varios registros de una tabla de Base de Datos Web siempre y cuando cumplan la condición dada.

Detalle
Las condiciones corresponden a la cláusula where de una sentencia sql y se emplea su sintaxis; para referenciar una tabla o una columna se debe emplear el código lógico de esta y debe estar entre corchetes.

Ejemplo de condición

[PARTICIPANTE_NOMBRE] = 'Pedro' AND [PARTICIPANTE_APELLIDO] = 'Perez'

Limitaciones

  • El sistema distingue entre mayúsculas y minúsculas en el código lógico de las tablas y columnas, por lo que se debe utilizar la correcta capitalización al referenciar a tablas y columnas.
  • En la condición solo se pueden utilizar columnas pertenecientes a la tabla indicada por argumento, si se trata de utilizar miembros de otras tablas el sistemas no los considerará válidos.
  • No están soportados los subquery (select dentro de la operación).

Sintaxis

public int delete(String idCompany,
String login,
String password,
String tableCode,
String conditions)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidQueryException,
InvalidCompanyException

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

tableCode Código lógico de la tabla en la cual se va a ejecutar la operación.

conditions Condición que deben cuamplir los registros a eliminar.

 

Valor devuelto

Cantidad de registros afectados, cero si no se eliminó ningún registro.

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un delete. Esto puede ocurrir porque:

  • la tabla indicada no existe,
  • no se indicó la tabla (es nulo o vacío),
  • el usuario no tiene permiso para eliminar registros de la tabla,
  • la tabla no tiene columnas,
  • al menos una de las columnas no existe.

InvalidQueryException – Si la condición es inválida, esto puede ocurrir porque es nula o vacía o porque existe un error de sintaxis.


InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.


10.deleteById

Elimina un registro de una tabla de Base de Datos Web dado su UID.

int deleteById(String idCompany,
String login,
String password,
String tableCode,
int uid)

Detalle de método deleteById

Elimina un registro de una tabla de Base de Datos Web dado su UID.

Sintaxis

public int deleteById(String idCompany,
String login,
String password,
String tableCode,
int uid)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidCompanyException

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

tableCode Código lógico de la tabla en la cual se va a ejecutar la operación.

uid Identificador del registro a ser eliminado.

 

Valor devuelto

Cantidad de registros afectados, cero si no se eliminó ningún registro.

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un delete. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso para eliminar registros de la tabla.

InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.


11.relatedDelete

Elimina un registro en una tabla de Base de Datos Web relacionada por un campo distinto al UID.

int relatedDelete(String idCompany,
String login,
String password,
String tableCode,
String conditions,
boolean relatedValue)

Detalle de método relatedDelete

Elimina uno o varios registros en una tabla de Base de Datos Web relacionada por un campo distinto al UID, siempre que cumplan con las condiciones dadas.
Detalle
Si el query debe evaluar condiciones, el valor de la condición se encierra entre llaves, por ejemplo [FIRST_NAME]={‘Pablo’}. Si el valor es un String, debe encerrarse entre comillas simples dentro de los corchetes.

Ejemplo de condición

[PROYECTO_NRO] = {1111} AND [PROYECTO_NOMBRE] = {'Proyecto Inicial'}

Sintaxis

public int relatedDelete(String idCompany,
String login,
String password,
String tableCode,
String conditions,
boolean relatedValue)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidQueryException,
InvalidCompanyException

Parámetros

idCompany – Identificador de la compañía propietaria de la base de datos.

login – Login del usuario que realiza la operación.

password – Clave del usuario que realiza la operación.

tableCode – Código lógico de la tabla en la cual se va a ejecutar la operación.

conditions – Condición que deben cuamplir los registros a actualizar.

relatedValue – Se asigna el valor de verdadero si la tabla está relacionadap or un campo distinto al UID.

 

Valor devuelto

Cantidad de registros afectados, cero si no se eliminó ningún registro.

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un delete. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso para eliminar registros de la tabla.

InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.



12.getIndexedColumns

Retorna todas las columnas de una tabla de Bases de Datos Web, que posean un indice a nivel de persistencia (MySQL).

StringMap getIndexedColumns(String idCompany,
String login,
String password,
String tableCode)

Detalle de método getIndexedColumns

Retorna todas las columnas de una tabla de Bases de Datos Web que posean un índice a nivel de persistencia (MySQL).

Limitaciones

El sistema distingue entre mayúsculas y minúsculas en el código lógico de las tablas y columnas, por lo que se debe utilizar la correcta capitalización al referenciar a tablas y columnas.
Sintaxis

public StringMap getIndexedColumns(String idCompany,
String login,
String password,
String tableCode)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidCompanyException

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

tableCode Código lógico de la tabla en la cual se va a ejecutar la operación.

 

Valor devuelto

Arreglo con el código lógico de todas las columnas que posean un índice a nivel de persistencia (MySQL).

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.

InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un select. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso para consultar registros de la tabla,
  • La tabla no tiene columnas,
  • Al menos una de las columnas no existe.

InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un select. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso para consultar registros de la tabla,
  • La tabla no tiene columnas,
  • Al menos una de las columnas no existe.

InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.



13.getTotalEntries

Retorna la cantidad de registros que arroja una consulta dada.

int getTotalEntries(String idCompany,
String login,
String password,
String query)

Detalle de método getTotalEntries

Retorna la cantidad de registros que arroja una consulta dada.

Limitaciones

El sistema distingue entre mayúsculas y minúsculas en el código lógico de las tablas y columnas, por lo que se debe utilizar la correcta capitalización al referenciar a tablas y columnas.

Sintaxis

public int getTotalEntries(String idCompany,
String login,
String password,
String query)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidQueryException,
InvalidCompanyException

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

query Query de consulta de los registros.

 

Valor devuelto

Cantidad de registros arrojados por la consulta realizada.

 

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un select. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso para consultar registros de la tabla,
  • La tabla no tiene columnas,
  • al menos una de las columnas no existe.

InvalidQueryException – Si el query es inválido, esto puede ocurrir porque es nulo o vacío o porque existe un error de sintaxis.


InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.



14.getTableColumnsCodes

Retorna un listado con los códigos de todas las columnas de una Base de Datos Web dada.

StringMap[] getTableColumnsCodes(String idCompany,
String login,
String password,
String tableCode)

Detalle de método getTableColumnsCodes

Retorna un listado con los códigos de todas las columnas de una Base de Datos Web dada.

Limitaciones

El sistema distingue entre mayúsculas y minúsculas en el código lógico de las tablas y columnas, por lo que se debe utilizar la correcta capitalización al referenciar a tablas y columnas.

Sintaxis

public StringMap[] getTableColumnsCodes(String idCompany,
String login,
String password,
String tableCode)
throws InvalidUserException,
InternalDanaException,
InvalidTableOrColumnException,
InvalidQueryException,
InvalidCompanyException

Parámetros

idCompany Identificador de la compañía propietaria de la base de datos.

login Login del usuario que realiza la operación.

password Clave del usuario que realiza la operación.

tableCode Código lógico de la tabla en la cual se va a ejecutar la operación.

Valor devuelto

Arreglo donde cada entrada corresponde a un objeto que contiene un diccionario con el valor de todas las columnas de la Base de Datos Web, la clave es el código lógico de la columna y el valor es el valor de la columna.

Excepciones

InvalidUserException – Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar Base de Datos Web bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.


InternalDanaException – Si ocurrió un error interno.


InvalidTableOrColumnException – Si la tabla o alguna de las columnas indicadas no son accesibles por el usuario para realizar un select. Esto puede ocurrir porque:

  • La tabla indicada no existe,
  • No se indicó la tabla (es nulo o vacío),
  • El usuario no tiene permiso para consultar registros de la tabla,
  • La tabla no tiene columnas,
  • Al menos una de las columnas no existe.

InvalidQueryException – Si el query es inválido, esto puede ocurrir porque es nulo o vacío o porque existe un error de sintaxis.


InvalidCompanyException – Si no existe una compañía registrada con el identificador suministrado.




Ver Tambien:
« | »