Package ca.cdr.api.transactionlog

Interface ITransactionLogFetchingSvc

public interface ITransactionLogFetchingSvc

This class is the entry point to retrieving Transaction Logs. In order to retrieve a transaction log, or search for transaction logs, it is critical to know the module which contains the log, since multiple modules can all be storing transaction logs. This interface allows you to select/search on a per-module basis.

Method Summary

Modifier and Type	Method	Description
List<String>	getModuleIdsOfTransactionLogReaders()	Lists all the Module IDs which are capable of fetching Transaction Logs.
Long	getNextId(String theModuleId, Long id)	Fetches the next PID given a certain PID.
org.springframework.data.domain.Page<TransactionLogEventsJson.TransactionLogEventJson>	getPageableTransactionLog(String theModuleId, Date theFrom, Date theTo, org.springframework.data.domain.Pageable thePageable, TransactionLogSearch theSearchParams)	This is the primary search method for retrieving Transaction logs in paginated fashion.
Long	getPreviousId(String theModuleId, Long id)	Fetches the previous PID given a certain PID.
TransactionLogEventsJson.TransactionLogEventJson	getTransactionEvent(String theModuleId, Long theId, boolean theIncludeBody)	Fetch one very specific Transcation Log by its known PID.
TransactionLogEventsJson	getTransactionLog(String theModuleId, Date theFrom, Date theTo, int thePageIndex, int thePageSize, TransactionLogSearch theSearchParams)	Deprecated.
TransactionLogStepBodySerializationModeEnum	getTransactionLogStepSerializationBodyType()	Returns the serialization mode for the body of the transaction log.
boolean	isShowRequestBody(String theModuleId)	whether the underlying system is configured to show the request body.

Method Details

getTransactionLogStepSerializationBodyType

TransactionLogStepBodySerializationModeEnum getTransactionLogStepSerializationBodyType()

Returns the serialization mode for the body of the transaction log.

Returns:

the serialization mode for the body of the transaction log.

getModuleIdsOfTransactionLogReaders

List<String> getModuleIdsOfTransactionLogReaders()

Lists all the Module IDs which are capable of fetching Transaction Logs.

Returns:

a list of module IDs.

getPageableTransactionLog

org.springframework.data.domain.Page<TransactionLogEventsJson.TransactionLogEventJson> getPageableTransactionLog(String theModuleId,
 Date theFrom,
 Date theTo,
 org.springframework.data.domain.Pageable thePageable,
 TransactionLogSearch theSearchParams)

This is the primary search method for retrieving Transaction logs in paginated fashion. You can filter using top-level parameters here. For a more detailed search, populate the TranscationLogSearch object.

Parameters:

theModuleId - the ID of the module which contains the transcation logs.

theFrom - the start date for the search

theTo - the end date for the search

thePageable - the pageable object.

theSearchParams - the TransactionLogSearch to refine your query. You can pass `TransactionLogSearch.all() if you do not want to refine.

Returns:

a Page of TransactionLogEventsJson.TransactionLogEventJson, each representing a Transcation Log.

getTransactionEvent

TransactionLogEventsJson.TransactionLogEventJson getTransactionEvent(String theModuleId,
 Long theId,
 boolean theIncludeBody)

Fetch one very specific Transcation Log by its known PID.

Parameters:

theModuleId - the ID of the module which contains the transaction logs.

theId - the PID of the Transaction Log.

theIncludeBody - Whether or not to include the body of the log.

Returns:

a TransactionLogEventsJson.TransactionLogEventJson.

getNextId

Long getNextId(String theModuleId,
 Long id)

Fetches the next PID given a certain PID.

getPreviousId

Long getPreviousId(String theModuleId,
 Long id)

Fetches the previous PID given a certain PID.

getTransactionLog

@Deprecated
TransactionLogEventsJson getTransactionLog(String theModuleId,
 Date theFrom,
 Date theTo,
 int thePageIndex,
 int thePageSize,
 TransactionLogSearch theSearchParams)

Deprecated.

This is the old method for retrieving Transaction Logs. It is not recommended to use this method, as it is not paginated. It is here for backwards compatibility. This method will be removed in a future release.

Parameters:

theModuleId - the ID of the module which contains the transaction logs.

theFrom - the start date for the search

theTo - the end date for the search

thePageIndex - the page index

thePageSize - the page size

theSearchParams - the TransactionLogSearch to refine your query. You can pass `TransactionLogSearch.all() if you do not want to refine.

Returns:

isShowRequestBody

boolean isShowRequestBody(String theModuleId)

whether the underlying system is configured to show the request body.

Parameters:

theModuleId - the ID of the module which contains the transaction logs.

Returns:

true if the request body will be shown.