AfsPafUploadReply Class Reference

Wrapper for reply of PaF upload document. More...

Inheritance diagram for AfsPafUploadReply:

Public Member Functions
	__construct ($reply)
	Construct PaF upload reply instance.
	in_error ()
	Check whether an error occured.
	get_error ()
	Retrieve error.
	has_result ()
	Check whether command execution succeded.
	get_result ()
	Retrieve result of the command.
Public Member Functions inherited from AfsHelperBase
	__get ($name)
	Simple property helper.

Detailed Description

Wrapper for reply of PaF upload document.

Constructor & Destructor Documentation

__construct

(

$reply

)

Construct PaF upload reply instance.

This class should only be instanciated by internal object and never by final user.

Parameters

$reply

[in] reply of an upload of one or mode documents.

Member Function Documentation

get_error

(

)

Retrieve error.

When an error occured, you can access to following useful properties:

• code: error code,
• message: error message,
• description: description of the error,
• details: internal details of the error (useful only when reporting error to Antidot support team).

Returns

error object or null when no error occured.

get_result

(

)

Retrieve result of the command.

When a result is available, you can access following useful properties:

• jobId: job identifier which can be used later to check whether the job succeeded,
• started: state of the job (boolean).

Returns

result object or null when an error occured.

has_result

(

)

Check whether command execution succeded.

Returns

true when there is no error, false otherwise.

in_error

(

)

Check whether an error occured.

Returns

true on error, false otherwise.