TSLIDataTransferObj
in
Interface que debe definirse para todo Data Transfer Object, el mismo que es usado como objeto goma entre las diferentes capas del sistema.
En este objeto deberan ponerse los parametros externos para que sea procesado en las capas posteriores y asi mismo las capas posteriores deberan poner los datos de salida en el mismo, sea que sea un mensaje de error o los datos obtenidos.
Table of Contents
| OP_FETCH | 'fetch' | |
|---|---|---|
| OP_READ | 'read' | |
| OP_UPDATE | 'upd' | |
| OP_DELETE | 'del' | |
| OP_ADD | 'add' | |
| addParameter() | Agrega parametros a usarse durante el desarrollo del bussines object. | void |
| getParameterValue() | Retorna el valor del parametro identificado por $parameterId | mixed |
| addModel() | Agrega un modelo de datos a trabajar identificado por $modeloId, | void |
| getModel() | Retorna la referencia al modelo identificado por $modelId | TSLDataModel|null |
| getOutMessage() | Retorna la referencia al mensaje de salida. | TSLOutMessage |
| getConstraints() | Retorna la referencia el objeto de constraints para su llenado. | TSLRequestConstraints |
| setOperation() | Setea el tipo de operacion a realizar por el request , estas pueden ser : 'add','del','fetch','upd' , cualquier otro valor por ahora no sera interpretado adecuadamente por la libreria pero podria ser usado por implementaciones propias. | void |
| getOperation() | Retorna el tipo de operacion a efectuar. se deja la interpretacion a la clase que requiera estaa informacion. | string |
| setSubOperationId() | Setea el subtipo de operacion a realizar por el request , digamos que existen diversas formas de hacer un fetch , aqui podria indicarse 'fetchAll','fetchOnlyassociated' por ejemplo , de tal manera que el bussiness object pueda determinar si una operacion tiene alguna sub opcion a ejecutar. | void |
| getSubOperation() | Retorna el tipo de suboperacion a efectua . se deja la interpretacion a la clase que requiera esta informacion. | string|null |
| getSessionUser() | Retorna el nombre del usuario de la sesion. | string |
| setSessionUser() | Setea el nombre del usuario de la sesion. | void |
Constants
OP_FETCH
mixed
$OP_FETCH
= 'fetch'
OP_READ
mixed
$OP_READ
= 'read'
OP_UPDATE
mixed
$OP_UPDATE
= 'upd'
OP_DELETE
mixed
$OP_DELETE
= 'del'
OP_ADD
mixed
$OP_ADD
= 'add'
Methods
addParameter()
Agrega parametros a usarse durante el desarrollo del bussines object.
public
addParameter(
$parameterId :
string
, $parameterData :
mixed
)
: void
Parameters
- $parameterId : string
que identifica al parametro , por ejemplo "orderby"
- $parameterData : mixed
que identifica el valor del parametro , pj "username"
getParameterValue()
Retorna el valor del parametro identificado por $parameterId
public
getParameterValue(
$parameterId :
string
)
: mixed
Parameters
- $parameterId : string
con el valor que idetifica al parametro
Return values
mixed —el objeto o valor del parametro.
addModel()
Agrega un modelo de datos a trabajar identificado por $modeloId,
public
addModel(
$modelId :
string
, &$model :
TSLDataModel
)
: void
Parameters
- $modelId : string
Identificador unico para este modelo
- $model : TSLDataModel
referencia al modelo de datos a procesar.
getModel()
Retorna la referencia al modelo identificado por $modelId
public
getModel(
$modelId :
string
)
: TSLDataModel|null
Parameters
- $modelId : string
el identificador unico del modelo a buscar
Return values
TSLDataModel|null —el cual es identificado por $modelId o null si no existe.
getOutMessage()
Retorna la referencia al mensaje de salida.
public
getOutMessage(
)
: TSLOutMessage
*
Return values
TSLOutMessage —conteniendo la data de respuesta con errores o data , dependiendo del tipo de retorno , osea con o sin error..
getConstraints()
Retorna la referencia el objeto de constraints para su llenado.
public
getConstraints(
)
: TSLRequestConstraints
Return values
TSLRequestConstraints —conteniendo los datos de entrada para ser usadops como constraints en la capa de datos.
setOperation()
Setea el tipo de operacion a realizar por el request , estas pueden ser : 'add','del','fetch','upd' , cualquier otro valor por ahora no sera interpretado adecuadamente por la libreria pero podria ser usado por implementaciones propias.
public
setOperation(
$operation :
string
)
: void
Por conveniencia usar las constantes de esta interfase :
TSLIDataTransferObj::OP_FETCH TSLIDataTransferObj::OP_ADD TSLIDataTransferObj::OP_DELETE TSLIDataTransferObj::OP_UPDATE TSLIDataTransferObj::OP_READ
Parameters
- $operation : string
Tipo de operacion a realizar por el request
getOperation()
Retorna el tipo de operacion a efectuar. se deja la interpretacion a la clase que requiera estaa informacion.
public
getOperation(
)
: string
Return values
string —con el tipo de operacion a efectuar
setSubOperationId()
Setea el subtipo de operacion a realizar por el request , digamos que existen diversas formas de hacer un fetch , aqui podria indicarse 'fetchAll','fetchOnlyassociated' por ejemplo , de tal manera que el bussiness object pueda determinar si una operacion tiene alguna sub opcion a ejecutar.
public
setSubOperationId(
$suboperation :
string
)
: void
Parameters
- $suboperation : string
subtipo de operacion a realizar por el request
getSubOperation()
Retorna el tipo de suboperacion a efectua . se deja la interpretacion a la clase que requiera esta informacion.
public
getSubOperation(
)
: string|null
Return values
string|null —con el tipo de suboperacion a efectuar
getSessionUser()
Retorna el nombre del usuario de la sesion.
public
getSessionUser(
)
: string
Return values
string —con el usuario de la sesion
setSessionUser()
Setea el nombre del usuario de la sesion.
public
setSessionUser(
$m_sessionUser :
string
)
: void
Parameters
- $m_sessionUser : string