com.secutix.plugin.dataexports

Interface ExportExecutor

All Known Implementing Classes:

ExportExecutorEmptyImpl

public interface ExportExecutor

Method Summary

Modifier and Type	Method and Description
void	executeExport(String exportQueryKey, Consumer<Map<String,String>> lineProcessor, boolean incremental, Integer nbMaxResults, Map<String,Object> queryParameters) Executes the query designated by the key and passes the lines procuced to the consumer.
default void	executeExport(String sqlQuery, String exportQueryKey, Consumer<Map<String,String>> lineProcessor, Integer nbMaxResults, Map<String,Object> queryParameters) Executes the query passed in first parameter, named by the second parameter.
void	flagItems(ItemKind kind, List<Long> elementIds, String functionCode)
default List<String>	getAvailableExports()
default void	unflagItems(ItemKind kind, List<Long> elementIds, String functionCode)

Method Detail

executeExport

void executeExport(String exportQueryKey,
                   Consumer<Map<String,String>> lineProcessor,
                   boolean incremental,
                   Integer nbMaxResults,
                   Map<String,Object> queryParameters)
            throws ExportExecutionException

Executes the query designated by the key and passes the lines procuced to the consumer.

Parameters:

exportQueryKey -

lineProcessor -

incremental - : if true, the export will only the contain the lines exported since the last successful execution.

nbMaxResults - : default : Integer.MAX_VALUE

queryParameters - : a very simple binding map parameters for the query. Only supported value types are : String, Number, Date and null

Throws:

ExportExecutionException

executeExport

default void executeExport(String sqlQuery,
                           String exportQueryKey,
                           Consumer<Map<String,String>> lineProcessor,
                           Integer nbMaxResults,
                           Map<String,Object> queryParameters)
                    throws ExportExecutionException

Executes the query passed in first parameter, named by the second parameter. If a query is stored in S-360 having for name exportQueryKey, then the stored query overrides the sqlQuery parameter.

Parameters:

sqlQuery - : SQL query to execute.

exportQueryKey - : name of the query.

lineProcessor - : processes the lines of the result.

nbMaxResults - : default : Integer.MAX_VALUE

queryParameters - : a very simple binding map parameters for the query. Only supported value types are : String, Number, Date and null

Throws:

ExportExecutionException

flagItems

void flagItems(ItemKind kind,
               List<Long> elementIds,
               String functionCode)
        throws ExportExecutionException

Parameters:

kind - : Type of elements to be flagged

elementIds - : Ids to be flagged

functionCode - : not mandatory. If passed, the items will be flagged as if flagged from the function passed as a parameter.

Throws:

ExportExecutionException

unflagItems

default void unflagItems(ItemKind kind,
                         List<Long> elementIds,
                         String functionCode)
                  throws ExportExecutionException

Parameters:

kind - : Type of elements to be unflagged

elementIds - : Ids to be unflagged

functionCode - : not mandatory. If passed, the items will be flagged as if flagged from the function passed as a parameter.

Throws:

ExportExecutionException

getAvailableExports

default List<String> getAvailableExports()

Returns:

the list of available export

Throws:

ExportExecutionException