Class Inx_Api_UpdateException

Description

This exception is thrown by the commitUpdate() method in the Inx_Api_BusinessObject class to indicate that the update failed.

This exception is thrown by the commitUpdate() method in the Inx_Api_BusinessObject class to indicate that the update failed. There are several error types associated with this exception:

  • ERROR_TYPE_PERSISTENCE - the update could not be persisted
  • ERROR_TYPE_ILLEGAL_VALUE - an illegal value was committed
  • ERROR_TYPE_DUPLICATE_KEY_VALUE - a duplicate key was committed
  • ERROR_TYPE_ILLEGAL_OPERATION - an illegal operation was triggered

  • version: $Revision$ $Date$ $Author$
  • see: commitUpdate()

Located in /Api/UpdateException.php (line 21)

Exception
   |
   --Inx_Api_UpdateException
Class Constant Summary
Variable Summary
Method Summary
Inx_Api_UpdateException __construct ($sMsg $sMsg, $iErrorCode $iErrorCode, $iErrorSource $iErrorSource)
Variables
mixed $iErrorSource (line 42)

The error source of this exception.

The error source of this exception.

  • access: protected
mixed $iErrorType (line 39)

The error type of this exception.

The error type of this exception.

  • access: protected

Inherited Variables

Inherited from Exception (Internal Class)

$code
$file
$line
$message
$previous
$string
$trace
Methods
Constructor __construct (line 54)

Creates a new Inx_Api_UpdateException with the given error type, error source and detail message.

Creates a new Inx_Api_UpdateException with the given error type, error source and detail message.

  • access: public
Inx_Api_UpdateException __construct ($sMsg $sMsg, $iErrorCode $iErrorCode, $iErrorSource $iErrorSource)
  • $sMsg $sMsg: the detail message.
  • $iErrorCode $iErrorCode: the error type. One of the error type constants defined in this exception.
  • $iErrorSource $iErrorSource: the error source. Can be either Inx_Api_UpdateException.ERROR_SOURCE_NOT_SPECIFIED or a more specific constant of a related Inx_Api_BusinessObject (e.g. Inx_Api_List_ListContext.ATTRIBUTE_NAME).

Redefinition of:
Exception::constructor __construct ( [$message = ], [$code = ], [$previous = ] )
getErrorSource (line 68)

Returns the error source. or a more specific constant of a related Inx_Api_BusinessObject.

Returns the error source. The error source can be Inx_ApiUpdateException::ERROR_SOURCE_NOT_SPECIFIED or a more specific constant of a related Inx_Api_BusinessObject. e.g. Inx_Api_List_ListContext::ATTRIBUTE_NAME if the list name is illegal or already exists.

  • return: the error source.
  • access: public
int getErrorSource ()

Inherited Methods

Inherited From Exception (Internal Class)

constructor __construct ( [$message = ], [$code = ], [$previous = ] )
getCode ( )
getFile ( )
getLine ( )
getMessage ( )
getPrevious ( )
getTrace ( )
getTraceAsString ( )
__clone ( )
__toString ( )
Class Constants
ERROR_SOURCE_NOT_SPECIFIED = -1000 (line 36)

Indicates that no error source was specified.

Indicates that no error source was specified.

ERROR_TYPE_DUPLICATE_KEY_VALUE = -3 (line 30)

Error type indicating that a duplicate key was committed.

Error type indicating that a duplicate key was committed.

ERROR_TYPE_ILLEGAL_OPERATION = -4 (line 33)

Error type indicating that an illegal operation was triggered.

Error type indicating that an illegal operation was triggered.

ERROR_TYPE_ILLEGAL_VALUE = -2 (line 27)

Error type indicating that an illegal value was committed.

Error type indicating that an illegal value was committed.

ERROR_TYPE_PERSISTENCE = -1 (line 24)

Error type indicating that a persistence error has occurred.

Error type indicating that a persistence error has occurred.

Documentation generated on Thu, 17 Sep 2015 14:27:34 +0200 by phpDocumentor 1.3.2