ePages 7.19.0 - DE_EPAGES/RemoteSearch/API/IndexStatus.pm

Package DE_EPAGES::RemoteSearch::API::IndexStatus

Index Status API

Base
Exporter
@EXPORT_OK
GetNextState
IndexStatusString
IndexStatusID
GetActiveStates
INDEXSTATUS_UNITIALIZED
INDEXSTATUS_PENDING
INDEXSTATUS_COMPLETE
INDEXSTATUS_ERROR
INDEXSTATUS_DIRTY
INDEXSTATUS_OFF

Functions

GetActiveStates
GetNextState
IndexStatusID
IndexStatusString

INDEXSTATUS_UNITIALIZED (string)

status: Uninitialized

INDEXSTATUS_PENDING (string)

status: Pending

INDEXSTATUS_COMPLETE (string)

status: Complete

INDEXSTATUS_ERROR (string)

status: Error

INDEXSTATUS_DIRTY (string)

status: Dirty

INDEXSTATUS_OFF (string)

status: Off

GetActiveStates

Returns index status values that match to an active (i.e. usable in storefront) index

Syntax
my $aStatusStrings = GetActiveStates();
Return
$aStatusStrings (ref.array.string)
status string values

GetNextState

state machine implementation. changes the index status along the defined event path.

Syntax
GetNextState( $currentState, $event );
Input
$currentState (string)
status string. see list of index status
$event (string)
Event based on TaskStatus. See com.epages.task.api.TaskStatus from epagesj
Return
$newstate (string)
new state

IndexStatusID

Return StatusID from string

Syntax
my $StatusID = IndexStatusID( $String );
Input
$String (string)
status string
Return
$StatusID (integer)
status id

IndexStatusString

Return Status string from id

Syntax
my $IndexStatusStrig = IndexStatusString( $StatusID );
Input
$StatusID (integer)
status id
Return
$String (string)
status string