Obtener listado de cierre de Terminal por páginas
La función getTerminalClosurePage
de checkServices
se utiliza para obtener un listado paginado de cortes realizados en la terminal. Esta función es esencial para revisar y gestionar los cierres de terminal de forma ordenada y paginada.
Parámetros
perPage
:Int
- Descripción: Número de registros por página.
- Ejemplo:
10
page
:Int
- Descripción: Número de la página actual.
- Ejemplo:
1
Callback: PaginateTerminalClosureCallback
- Descripción: Callback utilizado para recibir los resultados de la solicitud de listado de cortes de terminal.
- Métodos:
onError
: Este método se invoca cuando ocurre un error durante la solicitud del listado de cortes.- Parámetros:
error
(ErrorResponse): Un código y mensaje de error opcional que describe el fallo.code
código de errormessage
mensaje de error
- Descripción: Se llama cuando hay un error en el proceso de obtener el listado de cortes.
- Retorno: Se debe implementar el manejo del error.
- Parámetros:
onSuccessful
: Este método se invoca cuando se obtiene exitosamente el listado paginado de cortes de terminal.- Parámetros:
terminalCutList
(TerminalClosureList
?): Contiene la lista paginada de cortes y la información de paginación.
- Descripción: Se llama cuando se obtienen exitosamente los cortes de terminal.
- Retorno: Actualiza el estado con la lista de cortes y la información de paginación.
- Parámetros:
Datos de la Respuesta (TerminalClosureList
)
La respuesta TerminalClosureList
incluye:
docs
(List<TerminalClosure>): Lista de cortes de terminal.hasNextPage
(Boolean): Indica si hay más páginas disponibles para la paginación.
val checkServices: CheckServices = CheckServices.getInstance(context)
checkServices.getTerminalClosurePage(perPage, page,
object : PaginateTerminalClosureCallback.Stub() {
override fun onError(error: ErrorResponse) {
Log.e("getTerminalClosurePage", error.code)
}
override fun onSuccessful(terminalCutList: TerminalClosureList?) {
if (terminalCutList != null) {
// Agrega los nuevos cortes
// Actualiza el estado con la nueva lista de cortes
_terminalClosureDocs.value.addAll(terminalCutList.docs)
// Actualiza la página y la información de paginación
page++
hasNextPage = terminalCutList.hasNextPage
}
}
})
CheckServices checkServices = CheckServices.getInstance(this);
checkServices.getTerminalClosurePage(perPage, currentPage, new PaginateTerminalClosureCallback.Stub() {
@Override
public void onError(ErrorResponse error) {
Log.d("getTerminalClosurePage", error.code );
}
@Override
public void onSuccessful(TerminalClosureList preTerminalCut) {
Log.e("Successfull", "Success");
}
});
Obtener Cierre de Terminal Previo
La función preTerminalClosure
es utilizada para obtener información previa al cierre de terminal en la aplicación Pagando Check. Proporciona detalles que pueden ser necesarios antes de realizar el cierre de terminal.
Parámetros
No recibe parámetros adicionales.
Callback: PreTerminalClosureCallback
- Descripción: Callback utilizado para recibir los resultados de la solicitud de información previa al cierre de terminal.
- Métodos:
onSuccessful
: Este método se invoca cuando la solicitud de información previa al cierre de terminal es exitosa.- Parámetros:
preterminalClosure
(PreTerminalClosure?): Detalles previos al cierre de terminal obtenidos como resultado de la solicitud.
- Descripción: Se llama cuando la solicitud de información previa al cierre de terminal se completa exitosamente.
- Retorno: No retorna un valor, pero proporciona los detalles previos al cierre de terminal obtenidos.
- Parámetros:
onError
: Este método se invoca cuando ocurre un error durante la solicitud de información previa al cierre de terminal.- Parámetros:
error
(ErrorResponse): Un código y mensaje de error opcional que describe el fallo.code
código de errormessage
mensaje de error
- Descripción: Se llama cuando hay un error en la solicitud de información previa al cierre de terminal.
- Retorno: No retorna un valor, pero proporciona información sobre el error ocurrido.
- Parámetros:
/*
Declara una variable de solo lectura llamada
**checkServices** de tipo **CheckServices** y le asigna
la instancia de **CheckServices** obtenida mediante
el llamado al método **getInstance(context)**.
*/
val checkServices: CheckServices = CheckServices.getInstance(context)
/*
Llamada de la función preTerminalClosure que no recibe parámetros.
Responde a un PreTerminalClosureCallback que podría tener dos métodos: onSuccessful y onError.
*/
checkServices.preTerminalClosure(
object : PreTerminalClosureCallback.Stub() {
override fun onError(error: ErrorResponse) {
Log.e("preTerminalClosure", error.code)
}
override fun onSuccessful(preterminalClosure: PreTerminalClosure?) {
// Procesar los detalles previos al cierre de terminal exitosamente obtenidos
_preTerminalClosure.value = preterminalClosure
}
})
CheckServices checkServices = CheckServices.getInstance(this);
checkServices.preTerminalClosure(new PreTerminalClosureCallback.Stub() {
@Override
public void onError(ErrorResponse errorCode) {
Log.d("preTerminalClosure", error.code );
}
@Override
public void onSuccessful(PreTerminalClosure terminalClosure) throws RemoteException {
// Success
}
});
Generar Cierre
La función generateClosure
es utilizada para generar un cierre en la aplicación Pagando Check. Esta acción generalmente implica finalizar actividades y recopilar información relevante al momento del cierre.
Parámetros
password
:String
- Descripción: La contraseña asociada con el usuario que está generando el cierre. Debe ser tratada de manera segura.
- Ejemplo:
"contraseñaSegura123"
Callback: GenerateClosureCallback
- Descripción: Callback utilizado para recibir los resultados de la generación de cierre.
- Métodos:
onSuccessful
: Este método se invoca cuando la generación de cierre es exitosa.- Parámetros:
closureDetail
(ClosureDetail?): Detalles del cierre generados como resultado de la operación.
- Descripción: Se llama cuando la generación de cierre se completa exitosamente.
- Retorno: No retorna un valor, pero proporciona los detalles del cierre generados.
- Parámetros:
onError
: Este método se invoca cuando ocurre un error durante la generación de cierre.- Parámetros:
error
(ErrorResponse): Un código y mensaje de error opcional que describe el fallo.code
código de errormessage
mensaje de error
- Descripción: Se llama cuando hay un error en la generación de cierre.
- Retorno: No retorna un valor, pero proporciona información sobre el error ocurrido.
- Parámetros:
/*
Declara una variable de solo lectura llamada
**checkServices** de tipo **CheckServices** y le asigna
la instancia de **CheckServices** obtenida mediante
el llamado al método **getInstance(context)**.
*/
val checkServices: CheckServices = CheckServices.getInstance(context)
/*
Llamada de la función generateClosure que recibe como parámetro la contraseña y un objeto de callback.
Responde a un GenerateClosureCallback que podría tener dos métodos: onSuccessful y onError.
*/
checkServices.generateClosure(password,
object : GenerateClosureCallback.Stub() {
override fun onError(error: ErrorResponse) {
Log.e("generateClosure", error.code)
}
override fun onSuccessful(closureDetail: ClosureDetail?) {
// Procesar los detalles del cierre generados exitosamente
_closureDetail.value = closureDetail
callback()
}
})
CheckServices checkServices = CheckServices.getInstance(this);
checkServices.generateClosure(password, new GenerateClosureCallback.Stub() {
@Override
public void onError(ErrorResponse error) {
Log.d("generateClosure", error.code );
}
@Override
public void onSuccessful(ClosureDetail closureDetail) throws RemoteException {
// Success
}
});
Obtener Detalles de Cierre por ID
La función getClosureById
se utiliza para obtener detalles específicos de un cierre en la aplicación Pagando Check, identificado por su ID único.
Parámetros
id
:String
- Descripción: El ID único que identifica el cierre del cual se desean obtener los detalles.
- Ejemplo:
"cierreID123"
Callback: GetClosureByIdCallback
- Descripción: Callback utilizado para recibir los resultados de la solicitud de detalles de cierre por ID.
- Métodos:
onSuccessful
: Este método se invoca cuando la solicitud de detalles de cierre por ID es exitosa.- Parámetros:
closureDetail
(ClosureDetail?): Detalles del cierre obtenidos como resultado de la solicitud.
- Descripción: Se llama cuando la solicitud de detalles de cierre por ID se completa exitosamente.
- Retorno: No retorna un valor, pero proporciona los detalles del cierre obtenidos.
- Parámetros:
onError
: Este método se invoca cuando ocurre un error durante la solicitud de detalles de cierre por ID.- Parámetros:
error
(ErrorResponse): Un código y mensaje de error opcional que describe el fallo.code
código de errormessage
mensaje de error
- Descripción: Se llama cuando hay un error en la solicitud de detalles de cierre por ID.
- Retorno: No retorna un valor, pero proporciona información sobre el error ocurrido.
- Parámetros:
/*
Declara una variable de solo lectura llamada
**checkServices** de tipo **CheckServices** y le asigna
la instancia de **CheckServices** obtenida mediante
el llamado al método **getInstance(context)**.
*/
val checkServices: CheckServices = CheckServices.getInstance(context)
/*
Llamada de la función getClosureById que recibe como parámetro el ID del cierre.
Responde a un GetClosureByIdCallback que podría tener dos métodos: onSuccessful y onError.
*/
checkServices.getClosureById(id,
object : GetClosureByIdCallback.Stub() {
override fun onError(error: ErrorResponse) {
Log.e("getClosureById", error.code)
}
override fun onSuccessful(closureDetail: ClosureDetail?) {
// Procesar los detalles del cierre obtenidos exitosamente
Log.e("infoClosure", Gson().toJson(closureDetail))
_closureDetail.value = closureDetail
}
})
CheckServices checkServices = CheckServices.getInstance(this);
checkServices.getClosureById(id, new GetClosureByIdCallback.Stub() {
@Override
public void onError(ErrorResponse error) {
Log.d("getClosureById", error.code );
}
@Override
public void onSuccessful(ClosureDetail closureDetail) {
// Success
}
});