Class Inx_Api_LockException

Description

An Inx_Api_LockException is thrown if a lockable object (e.

An Inx_Api_LockException is thrown if a lockable object (e.g. Mailing) is already locked.

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

Located in /Api/LockException.php (line 13)

Exception
   |
   --Inx_Api_LockException
Method Summary
Inx_Api_LockException __construct (string $sMsg, Inx_Api_LockTicket $oLockTicket)
Variables

Inherited Variables

Inherited from Exception (Internal Class)

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

Constructs a Inx_Api_LockException with the specified detail message and specific details from lock owner.

Constructs a Inx_Api_LockException with the specified detail message and specific details from lock owner.

  • access: public
Inx_Api_LockException __construct (string $sMsg, Inx_Api_LockTicket $oLockTicket)
  • string $sMsg: the detail message.
  • Inx_Api_LockTicket $oLockTicket: the ticket of lock information.

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

Returns the lock ticket.

Returns the lock ticket. The lock ticket contains specific details from the lock owner.

  • return: the lock ticket.
  • access: public
Inx_Api_LockTicket getLockTicket ()

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:26 +0200 by phpDocumentor 1.3.2