GeneralResponse event object, represents general state response for multipurpose usage. More...

Inheritance diagram for dtm.EventObjects.GeneralResponse:

Collaboration diagram for dtm.EventObjects.GeneralResponse:

Public Member Functions
def	__init__ (self, errorCode=ERROR_OK, errorMessage="")
	constructor initialize response fields More...

def	toJSON (self)

Public Attributes
	errorCode
	The errorCode of request operation, zero means success. More...

	errorMessage
	The error message of request operation filled depends on. More...

	statuses
	The list of statuses in case of request used for group of objects or actions. More...

Static Public Attributes
int	ERROR_OK = 0

Detailed Description

GeneralResponse event object, represents general state response for multipurpose usage.

The GeneralResponse object used to return unspecific common purpose response to get request status information or query the request acknowledgement.

Definition at line 561 of file EventObjects.py.

Constructor & Destructor Documentation

◆ init()

def dtm.EventObjects.GeneralResponse.__init__	(	self,
		errorCode = `ERROR_OK`,
		errorMessage = `""`
	)

constructor initialize response fields

Parameters

idsList The task Id list.

Definition at line 570 of file EventObjects.py.

   def __init__(self, errorCode=ERROR_OK, errorMessage=""):
     
     self.errorCode = errorCode
     
     self.errorMessage = errorMessage
     
     self.statuses = []

Member Function Documentation

◆ toJSON()

def dtm.EventObjects.GeneralResponse.toJSON ( self )

Definition at line 581 of file EventObjects.py.

   def toJSON(self):
     return json.dumps(self, default=lambda o: o.__dict__, sort_keys=True, indent=4)

Member Data Documentation

◆ ERROR_OK

int dtm.EventObjects.GeneralResponse.ERROR_OK = 0

static

Definition at line 564 of file EventObjects.py.

◆ errorCode

dtm.EventObjects.GeneralResponse.errorCode

The errorCode of request operation, zero means success.

Definition at line 573 of file EventObjects.py.

◆ errorMessage

dtm.EventObjects.GeneralResponse.errorMessage

The error message of request operation filled depends on.

Definition at line 576 of file EventObjects.py.

◆ statuses

dtm.EventObjects.GeneralResponse.statuses

The list of statuses in case of request used for group of objects or actions.

Definition at line 579 of file EventObjects.py.

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

sources/hce/dtm/EventObjects.py

Public Member Functions

Public Attributes

Static Public Attributes