ePages 6.17.35 - DE_EPAGES/RemoteSearch/API/Batch.pm

Package DE_EPAGES::RemoteSearch::API::Batch

High level Batch API used by scripts from the RemoteSearch cartridge

Base
Exporter
@EXPORT_OK
BATCH_CONTEXTS
IsScheduleMode
GetBatchUpdateHandlerPackage
BatchUpdateProduct
BatchDeleteProduct
BatchUpdateProductType
RegisterDeleteHandler
RegisterUpdateHandler
RegisterProductTypeUpdateHandler

Functions

BatchDeleteProduct
BatchUpdateProduct
BatchUpdateProductType
GetBatchUpdateHandlerPackage
IsScheduleMode
RegisterUpdateHandler

BATCH_CONTEXTS (array.string)

batch contexts relevant for communicating product updates

BatchDeleteProduct

Batches a product delete call

Syntax
BatchDeleteProduct($Product);
Input
$Product (DE_EPAGES::Product::API::Object::Product)
product

BatchUpdateProduct

Batches a product update call

Syntax
BatchUpdateProduct($Product);
Input
$Product (DE_EPAGES::Product::API::Object::Product)
produc

BatchUpdateProductType

Batch update call for ProductType attributes.

Syntax
BatchUpdateProductType( $ProductType )
Input
$ProductType (object)
ProductType

GetBatchUpdateHandlerPackage

Returns BatchUpdateHandler package name, usable in DE_EPAGES::Trigger::API::BatchProcessor::HandleItem. The selected BatchProcessor depends on value returned by IsScheduleMode

Syntax
my $HandlerPackage = GetBatchUpdateHandlerPackage();
Return
$BatchUpdateHandlerPackage (string)
BatchUpdateHandler package name

IsScheduleMode

Check if RemoteSearch configured to react on hook events.

Syntax
my $RunInScheduleMode = IsScheduleMode();
Return
$RunInScheduleMode (boolean)
Value of System.RemoteSearchScheduleUpdates

RegisterUpdateHandler

Register ProductBatchProcessHandler which used by every HandleItem call.
see DE_EPAGES::RemoteSearch::API::Object::ProductBatchProcessHandler

Syntax
RegisterUpdateHandler($Context);
Input
$Context (string)
batch context key