Package com.oracle.communications.brm.cc.modules

Interface RequestInfoModule

All Superinterfaces:

BaseModule

All Known Implementing Classes:

PCMRequestInfoModule

public interface RequestInfoModule
extends BaseModule

Defines request-information business operations.

Method Summary

Modifier and Type	Method	Description
void	deleteRequest(String id)	Handles delete request.
List<RequestDetails>	getRequestDetails(String id, String status, String accountId, String programName)	Get request details
void	recordFailure(String id, String descr, String correlationId, String errorCode, Exception ex, Object payload)	Records failure in any REST API
String	recordRequest(RequestDetails requestDetails)	Record request in BRM

Methods inherited from interface com.oracle.communications.brm.cc.modules.BaseModule

getBaseOps, getURIContext, getUserContext, setBaseOps, setURIContext, setUserContext

Method Details

recordFailure

void recordFailure(String id,
 String descr,
 String correlationId,
 String errorCode,
 Exception ex,
 Object payload)
            throws EBufException

Records failure in any REST API

Parameters:

id - Account id or any other id like bill id which can be used as scope id

descr - Description of the action performed by the request

correlationId - correlation id

errorCode - error code of the exception

ex - Exception thrown from API PCM layer

payload - Request Payload from the API

Throws:

EBufException - if required data cannot be read from or written to the FList

recordRequest

String recordRequest(RequestDetails requestDetails)

Record request in BRM

Parameters:

requestDetails - request details for record request

Returns:

request failed rest id

getRequestDetails

List<RequestDetails> getRequestDetails(String id,
 String status,
 String accountId,
 String programName)

Get request details

Parameters:

id - request id like 0.0.0.1+-request-failed-rest+190684

status - status of request (0 or 1)

accountId - account poid 0.0.0.1+-account+112345

programName - Name of client application like Billing Care

Returns:

request details

deleteRequest

void deleteRequest(String id)

Handles delete request.

Parameters:

id - request id like 0.0.0.1+-request-failed-rest+190684