Package DE_EPAGES::FactFinder::API::Object::RemoteFactFinder
This represents the client part of the functions communicating with with FactFinder WebServices.
Functions
- account
- adminPasswordMD5
- adminUser
- backOfficeURL
- baseURL
- buildMatrix
- channelMmtURL
- createChannel
- createUser
- currentTime
- deleteChannel
- deleteUser
- downloadProductExport
- factory
- getAllChannels
- getAllUsers
- getRecommendation
- importURL
- isLogCommunication
- isLogStatistics
- isPremium
- logInformation
- new
- passwordMD5
- recommendationURL
- refreshDatabase
- refreshDbURL
- refreshSuggestDatabase
- scicURL
- search
- searchURL
- shopAlias
- ssoPostfix
- ssoPrefix
- startImport
- startSuggestImport
- suggest
- suggestURL
- updateUser
- uploadProducts
- userMmtURL
$SOAP_UPDATE_TIMEOUT (integer)
timeout for soap calls updating the FactFinder database (seconds) default: 300
$SOAP_SUGGEST_TIMEOUT (integer)
timeout for soap calls to the suggest API (seconds). default: 5
account
getter/setter for 'account'
Syntax |
my $account = $Object->account; $Object->account('value'); |
Input |
|
Return |
|
adminPasswordMD5
getter/setter for 'adminPasswordMD5'
Syntax |
my $adminPasswordMD5 = $Object->adminPasswordMD5; $Object->adminPasswordMD5('value'); |
Input |
|
Return |
|
adminUser
getter/setter for 'adminUser'
Syntax |
my $adminUser = $Object->adminUser; $Object->adminUser('value'); |
Input |
|
Return |
|
backOfficeURL
getter/setter for 'backOfficeURL'
Syntax |
my $backOfficeURL = $Object->backOfficeURL; $Object->backOfficeURL('value'); |
Input |
|
Return |
|
baseURL
getter/setter for 'baseURL'
Syntax |
my $baseURL = $Object->baseURL; $Object->baseURL('value'); |
Input |
|
Return |
|
buildMatrix
rebuilds recommendation matrix
Syntax |
buildMatrix( $Channel ); |
Input |
|
Return |
|
channelMmtURL
getter/setter for 'channelMmtURL'
Syntax |
my $channelMmtURL = $Object->channelMmtURL; $Object->channelMmtURL('value'); |
Input |
|
Return |
|
createChannel
invokes createChannel SOAP call
Syntax |
$Object->createChannel( $Channel ); |
Input |
|
Return |
|
createUser
creates FACT-Finder user via SOAP
Syntax |
$Object->createUser( $Username, $PasswordMD5); |
Input |
|
Return |
|
currentTime
getter/setter for 'currentTime'
Syntax |
my $currentTime = $Object->currentTime; $Object->currentTime('value'); |
Input |
|
Return |
|
deleteChannel
Removes a FACT-Finder channel
Syntax |
$Object->deleteChannel( $Channel, $Input2); |
Input |
|
Return |
|
deleteUser
deletes FACT-Finder user
Syntax |
deleteUser( $Username ); |
Input |
|
Return |
|
downloadProductExport
calls downloadProductExport via SOAP
Syntax |
$Object->downloadProductExport( $Channel, $File); |
Input |
|
Return |
|
factory
creates a RemoteFactFinder instance with settings from the Shop
Syntax |
my $Object = DE_EPAGES::FactFinder::API::Object::RemoteFactFinder->factory( $Shop ); |
Input |
|
Return |
|
getAllChannels
Retrieves Channel list
Syntax |
getAllChannels( $Input1 ); |
Return |
|
getAllUsers
fetches FACT-Finder user list
Syntax |
getAllUsers( ); |
Return |
|
getRecommendation
gets results from FACT-Finder recommendation engine
Syntax |
getRecommendation( $Channel, $Product, $Limit ); |
Input |
|
Return |
|
importURL
getter/setter for 'importURL'
Syntax |
my $importURL = $Object->importURL; $Object->importURL('value'); |
Input |
|
Return |
|
isLogCommunication
getter/setter for 'isLogCommunication'
Syntax |
my $isLogCommunication = $Object->isLogCommunication; $Object->isLogCommunication('value'); |
Input |
|
Return |
|
isLogStatistics
getter/setter for 'isLogStatistics'
Syntax |
my $isLogStatistics = $Object->isLogStatistics; $Object->isLogStatistics('value'); |
Input |
|
Return |
|
isPremium
getter/setter for 'isPremium'
Syntax |
my $isPremium = $Object->isPremium; $Object->isPremium('value'); |
Input |
|
Return |
|
logInformation
logs event information
Syntax |
logInformation( $hEventData ); |
Input |
|
Return |
|
new
creates a RemoteFactFinder instance. Use factory method to get an object with initialized values.
Syntax |
my $Object = DE_EPAGES::FactFinder::API::Object::RemoteFactFinder->new( %options ); |
Input |
|
Return |
|
passwordMD5
getter/setter for 'passwordMD5'
Syntax |
my $passwordMD5 = $Object->passwordMD5; $Object->passwordMD5('value'); |
Input |
|
Return |
|
recommendationURL
getter/setter for 'recommendationURL'
Syntax |
my $recommendationURL = $Object->recommendationURL; $Object->recommendationURL('value'); |
Input |
|
Return |
|
refreshDatabase
calls refreshDatabase via SOAP
Syntax |
$Object->refreshDatabase( $Channel); |
Input |
|
Return |
|
refreshDbURL
getter/setter for 'refreshDbURL'
Syntax |
my $refreshDbURL = $Object->refreshDbURL; $Object->refreshDbURL('value'); |
Input |
|
Return |
|
refreshSuggestDatabase
calls refreshSuggestDatabase via SOAP
Syntax |
$Object->refreshSuggestDatabase( $Channel); |
Input |
|
Return |
|
scicURL
getter/setter for 'scicURL'
Syntax |
my $scicURL = $Object->scicURL; $Object->scicURL('value'); |
Input |
|
Return |
|
search
gets ready the params and parses/adapts the result for/from the SOAP-request
Syntax |
search($Channel, $Query, $Page, $ResultsPerPage, $Filters, $Sorts); |
Input |
|
Return |
|
searchURL
getter/setter for 'searchURL'
Syntax |
my $searchURL = $Object->searchURL; $Object->searchURL('value'); |
Input |
|
Return |
|
shopAlias
getter/setter for 'shopAlias'
Syntax |
my $shopAlias = $Object->shopAlias; $Object->shopAlias('value'); |
Input |
|
Return |
|
ssoPostfix
getter/setter for 'ssoPostfix'
Syntax |
my $ssoPostfix = $Object->ssoPostfix; $Object->ssoPostfix('value'); |
Input |
|
Return |
|
ssoPrefix
getter/setter for 'ssoPrefix'
Syntax |
my $ssoPrefix = $Object->ssoPrefix; $Object->ssoPrefix('value'); |
Input |
|
Return |
|
startImport
calls startImport via SOAP
Syntax |
$Object->startImport( $Channel); |
Input |
|
Return |
|
startSuggestImport
calls startSuggestImport via SOAP
Syntax |
$Object->startSuggestImport( $Channel); |
Input |
|
Return |
|
suggest
calls FACT-Finder suggest service
Syntax |
$Object->suggest( $Channel, $Query, $Language); |
Input |
|
Return |
|
suggestURL
getter/setter for 'suggestURL'
Syntax |
my $suggestURL = $Object->suggestURL; $Object->suggestURL('value'); |
Input |
|
Return |
|
updateUser
updates channel rights on user
Syntax |
updateUser( $ChannelNames ); |
Input |
|
Return |
|
uploadProducts
upload product export file to fact-finder by calling all necessary SOAP actions: downloadProductExport, startImport, refreshDatabase, startSuggestImport, refreshSuggestDatabase
Syntax |
$Object->uploadProducts( $Channel, $File); |
Input |
|
userMmtURL
getter/setter for 'userMmtURL'
Syntax |
my $userMmtURL = $Object->userMmtURL; $Object->userMmtURL('value'); |
Input |
|
Return |
|