TSLDataTransferObj
in
implements
TSLIDataTransferObj
Implementacion del Data Transfer Object a ser usado por el framework.
Table of Contents
| $m_Models | La lista de modelos a usar, | array |
|---|---|---|
| $m_OutMessage | Contiene el mensaje de salida. | TSLOutMessage |
| $m_Constraints | Contiene los constraints de paginacion si se requirieran | TSLRequestConstraints |
| $m_sessionUser | El usuario de la session | string |
| $m_Parameters | El arreglo de parametros que asocia nombre y valor. | array |
| addModel() | Se agrega un model el cual sera usado para el proceso del bussiness object. | void |
| getModel() | Retorna la instancia de modelo basado en el id enviado, de no existir retorna un objeto indefinido. | TSLDataModel|null |
| addParameter() | Agrega parametros a usarse durante el desarrollo del bussines object. | void |
| getParameterValue() | Retorna el valor del parametro identificado por $parameterId | mixed |
| getOutMessage() | Retorna la instancia del objeto de salida. | TSLOutMessage |
| getConstraints() | Retorna la instancia de los constraints para ser seteada en otras capas del framework. | 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 |
| getSessionUser() | Retorna el nombre del usuario de la sesion. | string |
| setSessionUser() | Setea el nombre del usuario de la sesion. | void |
| 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 |
Properties
$m_Models
La lista de modelos a usar,
private
array
$m_Models
= \null
$m_OutMessage
Contiene el mensaje de salida.
private
TSLOutMessage
$m_OutMessage
= \null
$m_Constraints
Contiene los constraints de paginacion si se requirieran
private
TSLRequestConstraints
$m_Constraints
= \null
$m_sessionUser
El usuario de la session
private
string
$m_sessionUser
= \null
$m_Parameters
El arreglo de parametros que asocia nombre y valor.
private
array
$m_Parameters
= \null
Methods
addModel()
Se agrega un model el cual sera usado para el proceso del bussiness object.
public
addModel(
$modelId :
string
, &$model :
TSLDataModel
)
: void
Parameters
- $modelId : string
el identificador unico del modelo a usar
- $model : TSLDataModel
la nstancia del modelo
getModel()
Retorna la instancia de modelo basado en el id enviado, de no existir retorna un objeto indefinido.
public
getModel(
$modelId :
string
)
: TSLDataModel|null
Parameters
- $modelId : string
con el identificador unico de un modelo de trabajo.
Return values
TSLDataModel|null —la instancia del modelo.
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"
Tags
getParameterValue()
Retorna el valor del parametro identificado por $parameterId
public
getParameterValue(
$parameterId :
string
)
: mixed
Parameters
- $parameterId : string
con el valor que idetifica al parametro
Tags
Return values
mixed —el objeto o valor del parametro.
getOutMessage()
Retorna la instancia del objeto de salida.
public
getOutMessage(
)
: TSLOutMessage
*
Tags
Return values
TSLOutMessage —la intancia del mensaje de salida.
getConstraints()
Retorna la instancia de los constraints para ser seteada en otras capas del framework.
public
getConstraints(
)
: TSLRequestConstraints
Return values
TSLRequestConstraints —la intancia delos constraints.
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
Tags
getOperation()
Retorna el tipo de operacion a efectuar. se deja la interpretacion a la clase que requiera estaa informacion.
public
getOperation(
)
: string
Tags
Return values
string —con el tipo de operacion a efectuar
getSessionUser()
Retorna el nombre del usuario de la sesion.
public
getSessionUser(
)
: string
Tags
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
Tags
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
Tags
getSubOperation()
Retorna el tipo de suboperacion a efectua . se deja la interpretacion a la clase que requiera esta informacion.
public
getSubOperation(
)
: string|null
Tags
Return values
string|null —con el tipo de suboperacion a efectuar