ePages 6.10 - DE_EPAGES/WebService/API/WebService/FactoryService.pm

Package DE_EPAGES::WebService::API::WebService::FactoryService

provides web service access to objects

Example
use DE_EPAGES::WebService::API::Client;
my $FactoryService = DE_EPAGES::WebService::API::Client
    ->uri('urn://epages.de/WebService/FactoryService/2004/08')
    ->proxy("http://%2fUsers%2f$Login:$Password\@localhost:8080/epages/Store.soap");
my $ShopID = $FactoryService->objectByPath( '/Shops/DemoShop' )->result;

Functions

classByAlias
deleteXML
existsObject
existsObjectByPath
importXML
objectByPath
rootObject

classByAlias

Returns the class id by class name.

Syntax
$ClassID = $FactoryService->classByAlias( $Alias )->result;
Example
$ClassID = $FactoryService->classByAlias( 'Customer' )->result;
Input
$Alias (string)
class name
Return
$ClassID (integer)
class id

deleteXML

Deletes object specified in the file and marked with 'delete="1"'.

Syntax
$FactoryService->deleteXML( $FileName, $Path );
Example
$FactoryService->deleteXML( 'c:\\import\\DemoShop.xml', '/' );
Input
$FileName (string)
file name in the file system of the application server
$Path (string)
object path of the parent object

existsObject

Returns true if an object exists with the object id.

Syntax
$Exists = $FactoryService->existsObject( $ObjectID )->result;
Example
$Exists = $FactoryService->existsObject( 1254 )->result;
Input
$ObjectID (integer)
object id
Return
$Exists (boolean)
true if the object exists

existsObjectByPath

Returns true if an object exists with the object path.

Syntax
$Exists = $FactoryService->existsObjectByPath( $ObjectPath )->result;
Example
$Exists = $FactoryService->existsObjectByPath( '/Shops/DemoShop/' )->result;
Input
$ObjectPath (string)
object path
Return
$Exists (boolean)
true if the object exists

importXML

Imports the file.

Syntax
$FactoryService->importXML( $FileName, $Path );
Example
$FactoryService->importXML( 'c:\\import\\DemoShop.xml', '/' );
Input
$FileName (string)
file name in the file system of the application server
$Path (string)
object path of the parent object

objectByPath

Returns the object id by object path.

Syntax
$ObjectID = $FactoryService->objectByPath( $ObjectPath )->result;
Example
$ShopID = $FactoryService->objectByPath( '/Shops/DemoShop/' )->result;
Input
$ObjectPath (string)
object path
Return
$ObjectID (integer)
object id

rootObject

Returns the object id of the root object.

Syntax
$ObjectID = $FactoryService->rootObject->result;
Return
$ObjectID (integer)
object id