ePages 6.17.35 - DE_EPAGES/RemoteSearch/API/Object/IndexManagerParams.pm

Package DE_EPAGES::RemoteSearch::API::Object::IndexManagerParams

Data container for IndexManager options. Providing standard getter and setter for each attribute (constructor argument). See new

Functions

create
drop
enabled
fix
ignoreIsReadyToUse
info
log
new
reinit
scheduleUpdates
silent
singleShopCalls
statusCheckLoops
testing
update
updateAttributes
url

create

Getter/Setter for 'create' - create or use meta data and trigger shop indexing

Syntax
my $CreateIndex = $Params->create();
$Params->create( $CreateIndex );
Input
$CreateIndex (boolean)
should index be created
Return
$CreateIndex (boolean)
should index be created

drop

Getter/Setter for 'drop' - reset meta data drop remote index

Syntax
my $DropIndex = $Params->drop();
$Params->drop( $DropIndex );
Input
$DropIndex (boolean)
reset metadate and remote index
Return
$DropIndex (boolean)
reset metadate and remote index

enabled

Getter/Setter for 'enabled' - activate remote search for shop

Syntax
my $EnableRemoteSearch = $Params->enabled();
$Params->enabled( $EnableRemoteSearch );
Input
$EnableRemoteSearch (boolean)
activate remote search
Return
$EnableRemoteSearch (boolean)
activate remote search

fix

Getter/Setter for 'fix' - rebuild index to fix broken index

Syntax
my $FixBroken = $Params->fix();
$Params->fix( $FixBroken );
Input
$FixBroken (boolean)
fix broken index
Return
$FixBroken (boolean)
fix broken index

ignoreIsReadyToUse

Getter/Setter for 'ignoreIsReadyToUse' - skip checking if index is usable in Storefront

Syntax
my $SkipCheckReady = $Params->ignoreIsReadyToUse();
$Params->ignoreIsReadyToUse( $SkipCheckReady );
Input
$SkipCheckReady (boolean)
skip if check IsUseableAtStorefront
Return
$SkipCheckReady (boolean)
skip if check IsUseableAtStorefront

info

Getter/Setter for 'info' - write meta data to <STDOUT>

Syntax
my $InfoRequest = $Params->info();
$Params->info( $InfoRequest );
Input
$InfoRequest (boolean)
is an info request
Return
$InfoRequest (boolean)
is an info request

log

Getter/Setter for 'log' - activate communication log for shop

Syntax
my $LogCommunication = $Params->log();
$Params->log( $LogCommunication );
Input
$LogCommunication (boolean)
log communication
Return
$LogCommunication (boolean)
log coomunication

new

Syntax
my $Params = DE_EPAGES::RemoteSearch::API::Object::IndexManagerParams->new(%Options)
Input
%Options (hash)
  • silent - surpress output to <STDOUT> - boolean
  • testing - testmode, no changes - boolean
  • fix - rebuild index to fix broken index - boolean
  • update - update index by completly rebuilding remote index - boolean
  • drop - reset meta data drop remote index - boolean
  • create - create or use meta data and trigger shop indexing - boolean
  • reinit - replace metadata and remote index new ones - boolean
  • log - activate communication log for shop - boolean
  • url - set url for remote host - String
  • enabled - activate remote search for shop - boolean
  • updateAttributes - write meta data (log, url, enabled) to Shop/RootObject - boolean
  • info - write meta data to <STDOUT> - boolean
  • statusCheckLoops - each iteration check task status and sleep X seconds afterwards (start X=2s scales up to max X=8s) - int
  • ignoreIsReadyToUse - skip checking if index is usable in Storefront
  • scheduleUpdates - De-/activate scheduling update information triggered by hooks
  • singleShopCalls - Use slower single-shop update call to epagesj.
Return
$Params (object)
instance of this class

reinit

Getter/Setter for 'reinit' - replace metadata and remote index new ones

Syntax
my $ReinitIndex = $Params->reinit();
$Params->reinit( $ReinitIndex );
Input
$ReinitIndex (boolean)
reinit index
Return
$ReinitIndex (boolean)
reinit index

scheduleUpdates

Getter/Setter for 'scheduleUpdates' - De-/activate scheduling update information triggered by hooks

Syntax
my $IsScheduleMode = $Params->scheduleUpdates();
$Params->scheduleUpdates( $IsScheduleMode );
Input
$IsScheduleMode (boolean)
run search in schedule mode
Return
$IsScheduleMode (boolean)
run search in schedule mode

silent

Getter/Setter for 'silent' - surpress output to <STDOUT>

Syntax
my $IsSilent = $Params->silent();
$Params->silent( $IsSilent );
Input
$IsSilent (boolean)
should output be surpressed
Return
$IsSilent (boolean)
is output surpressed

singleShopCalls

Getter/Setter for 'singleShopCalls' - Use slower single-shop update call to epagesj.

Syntax
my $IsSingleShopCalls = $Params->singleShopCalls();
$Params->singleShopCalls( $IsSingleShopCalls );
Input
$IsSingleShopCalls (boolean)
use single-shop updates
Return
$IsSingleShopCalls (boolean)
use single-shop updates

statusCheckLoops

Getter/Setter for 'statusCheckLoops' - poll index X number of times. Each loop waits for certain amount of time: Sleep time in seconds for each loop: 2,3,4,5,6,7,8,8,8,8...

Syntax
my $Wait = $Params->statusCheckLoops();
$Params->statusCheckLoops( $Wait );
Input
$Wait (integer)
pool index status
Return
$Wait (integer)
pool index status

testing

Getter/Setter for 'testing' - test mode no chance will be applied

Syntax
my $IsTestRun = $Params->testing();
$Params->testing( $IsTestRun );
Input
$IsTestRun (boolean)
is this a test run
Return
$IsTestRun (boolean)
running in test mode

update

Getter/Setter for 'update' - update index by completly rebuilding remote index

Syntax
my $DoUpdate = $Params->update();
$Params->update( $DoUpdate );
Input
$DoUpdate (boolean)
update index
Return
$DoUpdate (boolean)
update index

updateAttributes

Getter/Setter for 'updateAttributes' - write meta data (log, url, enabled) to Shop/RootObject

Syntax
my $UpdateAttributes = $Params->updateAttributes();
$Params->updateAttributes( $UpdateAttributes );
Input
$UpdateAttributes (boolean)
write meta data
Return
$UpdateAttributes (boolean)
write meta data

url

Getter/Setter for 'url' - url for remote search provider

Syntax
my $RemoteHostURL = $Params->url();
$Params->url( $RemoteHostURL );
Input
$RemoteHostURL (String)
url remote host
Return
$RemoteHostURL (String)
url remote host