Class Inx_Api_TriggerMailing_TriggerMailingStateException

Description

An Inx_Api_TriggerMailing_TriggerMailingStateException is thrown when a trigger mailing action is invoked which is not allowed to be performed in the current state. not allowed if the mailing is in the state TriggerMailingState::APPROVAL_REQUESTED(), thus raising a TriggerMailingStateException.

An Inx_Api_TriggerMailing_TriggerMailingStateException is thrown when a trigger mailing action is invoked which is not allowed to be performed in the current state. For example, invoking TriggerMailing::activateSending() is not allowed if the mailing is in the state TriggerMailingState::APPROVAL_REQUESTED(), thus raising a TriggerMailingStateException.

  • author: chge, 31.05.2012
  • since: API 1.10.0

Located in /Api/TriggerMailing/TriggerMailingStateException.php (line 16)

Exception
   |
   --Inx_Api_TriggerMailing_TriggerMailingStateException
Method Summary
Inx_Api_TriggerMailing_TriggerMailingStateException __construct (string $sMsg, Inx_Api_TriggerMailing_TriggerMailingState $currentMailingState, Inx_Api_TriggerMailing_TriggerState $currentTriggerState, bool $blLocked)
bool isLocked ()
Variables

Inherited Variables

Inherited from Exception (Internal Class)

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

Creates a TriggerMailingStateException with the given detail message, current state and locking state.

Creates a TriggerMailingStateException with the given detail message, current state and locking state.

  • access: public
Inx_Api_TriggerMailing_TriggerMailingStateException __construct (string $sMsg, Inx_Api_TriggerMailing_TriggerMailingState $currentMailingState, Inx_Api_TriggerMailing_TriggerState $currentTriggerState, bool $blLocked)

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

Returns the current state of the affected trigger mailing.

Returns the current state of the affected trigger mailing.

  • return: the current state of the trigger mailing.
  • access: public
Inx_Api_TriggerMailing_TriggerMailingState getCurrentMailingState ()
getCurrentTriggerState (line 61)

Returns the current state of the trigger of the affected trigger mailing.

Returns the current state of the trigger of the affected trigger mailing.

  • return: the current state of the trigger.
  • access: public
Inx_Api_TriggerMailing_TriggerState getCurrentTriggerState ()
isLocked (line 72)

Checks if the trigger mailing is locked.

Checks if the trigger mailing is locked.

  • return: true if the trigger mailing is locked, false otherwise.
  • access: public
bool isLocked ()

Inherited Methods

Inherited From Exception (Internal Class)

constructor __construct ( [$message = ], [$code = ], [$previous = ] )
getCode ( )
getFile ( )
getLine ( )
getMessage ( )
getPrevious ( )
getTrace ( )
getTraceAsString ( )
__clone ( )
__toString ( )

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