Class Inx_Api_Mailing_MailingStateException

Description

An Inx_Api_Mailing_MailingStateException is thrown when a mailing action is invoked which is not allowed to be performed in the current state.

An Inx_Api_Mailing_MailingStateException is thrown when a mailing action is invoked which is not allowed to be performed in the current state. For example, invoking Inx_Api_Mailing_Mailing::startSending() is not allowed if the mailing is in the state Inx_Api_Mailing_Mailing::STATE_TO_BE_APPROVE, thus raising a MailingStateException.

  • version: $Revision: 9497 $ $Date: 2007-12-19 17:03:25 +0200 (Tr, 19 Grd 2007) $ $Author: aurimas $

Located in /Api/Mailing/MailingStateException.php (line 17)

Exception
   |
   --Inx_Api_Mailing_MailingStateException
Method Summary
Inx_Api_Mailing_MailingStateException __construct ([string $sMsg = null], [int $iCurrentState = null], [bool $blLocked = null])
bool isLocked ()
Variables

Inherited Variables

Inherited from Exception (Internal Class)

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

Creates a

  1. MailingStateException
with the given detail message, current state and locking state.

Creates a

  1. MailingStateException
with the given detail message, current state and locking state.

  • access: public
Inx_Api_Mailing_MailingStateException __construct ([string $sMsg = null], [int $iCurrentState = null], [bool $blLocked = null])
  • string $sMsg: the detail message.
  • int $iCurrentState: the current state of the affected mailing.
  • bool $blLocked:
    1. true
    if the mailing is locked,
    1. false
    otherwise.

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

Returns the current state of the affected mailing.

Returns the current state of the affected mailing. Alias for Inx_Api_Mailing_MailingStateException::getCode()

  • return: the current state.
  • access: public
int getCurrentState ()
isLocked (line 57)

Checks if the mailing is locked.

Checks if the mailing is locked.

  • return: true if the 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:27 +0200 by phpDocumentor 1.3.2