Package DE_EPAGES::RemoteSearch::API::Object::SearchIndex
object interface for SearchIndex.
Base |
DE_EPAGES::Object::API::Object::Object |
Functions
- className
- dbPackage
- deleteItems
- deleteItemsByGUID
- drop
- getUpdateTask
- initialize
- initializeNoSolr
- isActive
- isLogging
- logContextString
- logger
- remoteIndex
- remoteSearch
- remoteSuggest
- updateIndexStatus
- updateItems
- updateItemsByGUID
- usableAtStorefront
className
Returns the class name, used for DAL access.
Syntax |
my $ClassName = $SearchIndex->className; |
Return |
|
dbPackage
Returns the database package, used for DAL access.
Syntax |
my $DbPackage = $SearchIndex->dbPackage; |
Return |
|
deleteItems
Deletes objects from the search index
Syntax |
$Index->deleteItems( $aObjects ); |
Input |
|
Return |
|
deleteItemsByGUID
Deletes products from the search index
Syntax |
$Index->deleteItemsByGUID( $aObjectGUIDs ); |
Input |
|
Return |
|
drop
Drops the remote index
Syntax |
$Index->drop(); |
Return |
|
getUpdateTask
Fetches the update task referenced in #UpdateTaskURL attribute.
Syntax |
my $Task = $Index->getUpdateTask(); |
Return |
|
initialize
Initialize search index, initiating a remote init call and saving the task.
Syntax |
$Index->initialize(); |
Return |
|
Hook |
|
initializeNoSolr
update shop collection only, solr is not involvedk.
Syntax |
$Index->initializeNoSolr(); |
isActive
Returns true, if remote search is enabled on system level and on shop level. Use method usableAtStorefront to check if the remote search should be used in the storefront.
Syntax |
my $isActive = $Index->isActive(); |
Return |
|
isLogging
Use to check if logging is enabled.
Syntax |
my $isLogging = $Index->isLogging(); |
Return |
|
logContextString
Returns object context string based on storename, object path and shop GUID, used for logging.
Syntax |
my $ContextString = $Index->logContextString(); |
Return |
|
logger
Returns a logger object used for communication logging
Syntax |
my $Logger = $Index->logger(); |
Return |
|
remoteIndex
returns the remote adapter object used for managing the remote index. See DE_EPAGES::RemoteSearch::API::Object::RemoteIndexClient
Syntax |
my $RemoteIndex = $Index->remoteIndex(); |
Return |
|
remoteSearch
returns the remote adapter object used for calling the search webservice. See DE_EPAGES::RemoteSearch::API::Object::SearchClient
Syntax |
my $RemoteSearch = $Index->remoteSearch(); |
Return |
|
remoteSuggest
returns the remote adapter object used for calling the suggestion webservice. See DE_EPAGES::RemoteSearch::API::Object::SuggestClient
Syntax |
my $RemoteSuggest = $Index->remoteSuggest(); |
Return |
|
updateIndexStatus
Updates the local index status based on the task status. The Task URL can be retrieved by listening to the Hook 'API_RemoteSearchUpdateTaskStatus'.
Syntax |
$Index->updateIndexStatus( $Task ); |
Input |
|
Hook |
|
updateItems
Updates or inserts a list of objects within search index.
Syntax |
$Index->updateItems( $aObjects ); |
Input |
|
Return |
|
updateItemsByGUID
Updates or inserts a list of objects within search index.
Syntax |
$Index->updateItemsByGUID( $aObjectGUIDs ); |
Input |
|
Return |
|
usableAtStorefront
Returns true, if the search is usable at the storefront. This depends on isActive and on the actual indexstatus of the shop. In TLEs, use #IsUsableAtStorefront.
Syntax |
my $usableAtStorefront = $Index->usableAtStorefront( ); |
Return |
|