HCE Project PHP language client API bindings OOP style  1.1.1
Hierarchical Cluster Engine PHP Client Interface API OOP style
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Protected Attributes | List of all members
HCE\admin\NodeManageResponse Class Reference

Public Member Functions

 getResponse ()
 setResponse ($transportResponse)
 setErrorCode ($errorCode)
 getErrorCode ()
 getResponseMessageBody ($messageItem=0)
 getResponseMessageId ($messageItem=0)
 getResponseMessageErrorCode ($messageItem=0)
 getResponseCommandFields ($messageItem=0)
 __construct ($transportResponse=null)
 __destruct ()

Protected Attributes

 $transportResponse = null
 $error = 0

Detailed Description

HCE Request class implements basic functionality of client-side of HCE Cluster Node application interaction

Definition at line 21 of file NodeManageResponse.inc.php.

Constructor & Destructor Documentation

HCE\admin\NodeManageResponse::__construct (   $transportResponse = null)

create instance

Definition at line 134 of file NodeManageResponse.inc.php.

HCE\admin\NodeManageResponse::__destruct ( )

Delete node manage response objext

Definition at line 144 of file NodeManageResponse.inc.php.

Member Function Documentation

HCE\admin\NodeManageResponse::getErrorCode ( )

Returns erro code of last executed request

Returns
error code

Definition at line 68 of file NodeManageResponse.inc.php.

HCE\admin\NodeManageResponse::getResponse ( )

Returns response

Returns
transport response object

Definition at line 37 of file NodeManageResponse.inc.php.

HCE\admin\NodeManageResponse::getResponseCommandFields (   $messageItem = 0)

Returns array of fields parsed from transport response message raw body

Returns
fields array(FIELD_NAME=>FIELD_VALUE), common FIELD_NAME is 'status', another fields names depends on command; all command specific fields can be NULL in case of wrong response or ERROR response status

Definition at line 105 of file NodeManageResponse.inc.php.

HCE\admin\NodeManageResponse::getResponseMessageBody (   $messageItem = 0)

Returns transport response message raw body field

Returns
response body

Definition at line 77 of file NodeManageResponse.inc.php.

HCE\admin\NodeManageResponse::getResponseMessageErrorCode (   $messageItem = 0)

Returns transport response message error field

Returns
response error code

Definition at line 95 of file NodeManageResponse.inc.php.

HCE\admin\NodeManageResponse::getResponseMessageId (   $messageItem = 0)

Returns transport response message id field

Returns
response id

Definition at line 86 of file NodeManageResponse.inc.php.

HCE\admin\NodeManageResponse::setErrorCode (   $errorCode)

Set error code

Parameters
$errorCode- error code

Definition at line 59 of file NodeManageResponse.inc.php.

HCE\admin\NodeManageResponse::setResponse (   $transportResponse)

Set response

Parameters
$transportResponse- transport response object

Definition at line 48 of file NodeManageResponse.inc.php.

Member Data Documentation

HCE\admin\NodeManageResponse::$error = 0
protected

Response error code of last operation result

Definition at line 30 of file NodeManageResponse.inc.php.

HCE\admin\NodeManageResponse::$transportResponse = null
protected

Response data

Definition at line 25 of file NodeManageResponse.inc.php.

The documentation for this class was generated from the following file: