BiBiServ::Status - Represents status of a webservice call on client side.
my $status = new BiBiServ::Status(WSCTools=>$WSCTools);
where $WSCTools is a reference to a former build BiBiServ::WSCTools object.
(for a introduction and complete documentation see "BiBiServ WebService Developers Guide")
This module provides access to the information of a webservice call. It differs in details from the server side Status.java, but is written as simular as possible and useful.
All information returned by the webservice server is represented here. If an error occoured on client side the statuscode has to beginn with a ``c''.
We (the BiBiServ Administrators) have some rules to follow, so a WebService and the http-Client can work on our System. Using BiBiServ:: is the simpliest way to follow our rules. E.g. providing a complete error handling.
This is the contructor. It requires a former build BiBiServ::WSCTools object
my $status = new BiBiServ::Status(WSCTools=>$WSCTools);
Parameters:
$WSCTools : BiBiServ::WSCTools object.
returns contructed object or undef if an error occoured.
sets id of webservice call
$status->setId($id);
Parameters:
$id : id to set
returns id of webservice call
my $id = $status->getId();
sets statuscode, description
$status->setStatuscode($statuscode,$description,$internalDescription);
Parameters:
$statuscode : statuscode (integer) to set
$description : description of statuscode
$internalDescription : internal description of statuscode
If statuscode begins with ``c'' (means this is a client side error) and $description,$internalDescription is null, looking this up at the propertie files
returns current statuscode
my $statuscode = $status->getStatuscode();
sets description
$status->setDescription($description, $internalDescription);
Parameters:
$description : description of statuscode
$internalDescription : internal description of statuscode
returns description
my $description = $status->getDescription();
returns internalDescription
my $internalDescription= $status->getInternalDescription();
returns toolanme
my $toolname = $status->getToolname();
set a reference to result (for response method)
$status->setResultRef($resultRef);
Parameters:
$resultRef : reference to result of webservice call
returns a reference to the results (after response method call)
my $resultRef = $status->getResultRef();
returns information of status as human readable String (e.g. for logging)
my $statusinfo = $status->toString()
sets statuscode and description to info of saop fault, which you got from Soap::Lite.
$status->soapFaultHandler($soap,$res)
Parameters:
$soap : soap_* object of SOAP::Lite
$res : Transport error object of SOAP::Lite