Class Teamnet_Fax_Soap_Client_Job

Description

Client class to obtain or alter faxjobs using the Teamnet FaxAPI webservice

  • author: tingelhoff@teamnet.de
  • version: 1.0
  • copyright: Teamnet GmbH

Located in /SoapClient/main/classes/Teamnet/Fax/Soap/Client/Job.php (line 11)


	
			
Method Summary
static void createPeriod (string $sFrom, string $sUntil)
Teamnet_Fax_Soap_Client_Job __construct ( $wsdl,  $authKey)
APIJob getJob (int $iJobID)
float|null getJobCosts (int $iJobID)
array getJobMembers (int $iJobID)
APIJobProfile getJobProfile (int $iJobID)
array getList ([string|null $sTitle = null], [string|null $sStatus = null], [Period $oPeriod = null])
array getMembers ([string|null $sTitle = null], [string|null $sStatus = null], [Period $oPeriod = null])
string getTransportStatus (int $iJobID)
null setTransportStatus (int $iJobID, string $sTransportStatus)
Methods
static method createPeriod (line 35)

Create a period object

  • access: public
static void createPeriod (string $sFrom, string $sUntil)
  • string $sFrom: Begin of the period formatted as ISO 8601 date
  • string $sUntil: End of the period formatted as ISO 8601 date
Constructor __construct (line 19)
  • access: public
Teamnet_Fax_Soap_Client_Job __construct ( $wsdl,  $authKey)
  • $wsdl
  • $authKey
getJob (line 111)

Gets the current status of a specific job

  • throws: MaintenanceException if the fax service is currently down for maintenance
  • throws: ServiceException if an internal error in the fax service occured
  • throws: SoapFault if another SOAP related error occured
  • throws: ParameterException if parameters are invalid
  • throws: AuthentificationException if the given AuthKey is invalid
  • throws: JobNotFoundException if an job with the given ID was not found
  • access: public
APIJob getJob (int $iJobID)
  • int $iJobID: JobID
getJobCosts (line 82)

Gets the costs of a specific job

  • throws: MaintenanceException if the fax service is currently down for maintenance
  • throws: ServiceException if an internal error in the fax service occured
  • throws: SoapFault if another SOAP related error occured
  • throws: ParameterException if parameters are invalid
  • throws: AuthentificationException if the given AuthKey is invalid
  • throws: JobNotFoundException if an job with the given ID was not found
  • access: public
float|null getJobCosts (int $iJobID)
  • int $iJobID
getJobMembers (line 53)

Gets a list of members associated to a specific job

  • return: of APIJobMemberList objects
  • throws: MaintenanceException if the fax service is currently down for maintenance
  • throws: ServiceException if an internal error in the fax service occured
  • throws: SoapFault if another SOAP related error occured
  • throws: ParameterException if parameters are invalid
  • throws: AuthentificationException if the given AuthKey is invalid
  • throws: JobNotFoundException if an job with the given ID was not found
  • access: public
array getJobMembers (int $iJobID)
  • int $iJobID
getJobProfile (line 140)
  • throws: MaintenanceException if the fax service is currently down for maintenance
  • throws: ServiceException if an internal error in the fax service occured
  • throws: SoapFault if another SOAP related error occured
  • throws: ParameterException if parameters are invalid
  • throws: AuthentificationException if the given AuthKey is invalid
  • throws: JobNotFoundException if an job with the given ID was not found
  • access: public
APIJobProfile getJobProfile (int $iJobID)
  • int $iJobID: JobID
getList (line 170)

Returns a list of APIJob objects matching the delivered search parameters

  • return: APIJob objects
  • throws: ServiceException if an internal error in the fax service occured
  • throws: MaintenanceException if the fax service is currently down for maintenance
  • throws: ParameterException if parameters are invalid
  • throws: SoapFault if another SOAP related error occured
  • throws: AuthentificationException if the given AuthKey is invalid
  • access: public
array getList ([string|null $sTitle = null], [string|null $sStatus = null], [Period $oPeriod = null])
  • string|null $sTitle
  • string|null $sStatus
  • Period|null $oPeriod
getMembers (line 202)

Returns a list of APIJobMember objects matching the delivered search parameters

  • return: APIJobMember objects
  • throws: ServiceException if an internal error in the fax service occured
  • throws: MaintenanceException if the fax service is currently down for maintenance
  • throws: ParameterException if parameters are invalid
  • throws: SoapFault if another SOAP related error occured
  • throws: AuthentificationException if the given AuthKey is invalid
  • access: public
array getMembers ([string|null $sTitle = null], [string|null $sStatus = null], [Period $oPeriod = null])
  • string|null $sTitle
  • string|null $sStatus
  • Period|null $oPeriod
getTransportStatus (line 234)

Gets the current transport state of a specific job

  • return: the current transport status
  • throws: MaintenanceException if the fax service is currently down for maintenance
  • throws: ServiceException if an internal error in the fax service occured
  • throws: SoapFault if another SOAP related error occured
  • throws: ParameterException if parameters are invalid
  • throws: AuthentificationException if the given AuthKey is invalid
  • throws: JobNotFoundException if an job with the given ID was not found
  • access: public
string getTransportStatus (int $iJobID)
  • int $iJobID
setTransportStatus (line 264)

Alters the transport status of a specific job

  • throws: MaintenanceException if the fax service is currently down for maintenance
  • throws: ServiceException if an internal error in the fax service occured
  • throws: SoapFault if another SOAP related error occured
  • throws: ParameterException if parameters are invalid
  • throws: AuthentificationException if the given AuthKey is invalid
  • throws: JobNotFoundException if an job with the given ID was not found
  • access: public
null setTransportStatus (int $iJobID, string $sTransportStatus)
  • int $iJobID
  • string $sTransportStatus: the transport status to set

Documentation generated on Wed, 18 May 2011 15:47:40 +0200 by phpDocumentor 1.4.1