Class Inx_Api_LockTicket

Description

An Inx_Api_LockTicket contains specific informations about a lock of an object (e.

An Inx_Api_LockTicket contains specific informations about a lock of an object (e.g. Mailing). The information provided includes:

  • The id of the user who holds the lock
  • The name of the user who holds the lock
  • The internet address of the lock owner
  • The creation date of the lock
  • Whether the object is locked by this session

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

Located in /Api/LockTicket.php (line 22)


	
			
Method Summary
Inx_Api_LockTicket __construct (integer $iUserId, string $sUserName, string $sSource, string $sCreationDatetime, boolean $blForeignLock)
string getSource ()
string getUserId ()
string getUserName ()
boolean isForeignLock ()
Methods
Constructor __construct (line 45)

Constructs a Inx_Api_LockTicket with the specified details of the lock owner.

Constructs a Inx_Api_LockTicket with the specified details of the lock owner.

  • access: public
Inx_Api_LockTicket __construct (integer $iUserId, string $sUserName, string $sSource, string $sCreationDatetime, boolean $blForeignLock)
  • integer $iUserId: the user id from of the lock owner.
  • string $sUserName: the user name of the lock owner.
  • string $sSource: the internet address of the lock owner.
  • string $sCreationDatetime: the creation date of the existing lock.
  • boolean $blForeignLock: true if locked by another session, false if locked by this session.
getCreationDatetime (line 61)

Returns the creation date of the existing lock as ISO 8601 formatted date string.

Returns the creation date of the existing lock as ISO 8601 formatted date string.

  • return: the creation date of the existing lock.
  • access: public
string getCreationDatetime ()
getSource (line 71)

Returns the internet address of the lock owner.

Returns the internet address of the lock owner.

  • return: the internet address of the lock owner.
  • access: public
string getSource ()
getUserId (line 81)

Returns the user id of the lock owner.

Returns the user id of the lock owner.

  • return: the user id of the lock owner.
  • access: public
string getUserId ()
getUserName (line 91)

Returns the user name of the lock owner.

Returns the user name of the lock owner.

  • return: the user name of the lock owner.
  • access: public
string getUserName ()
isForeignLock (line 101)

Checks if the object is locked by this session.

Checks if the object is locked by this session.

  • return: true if locked by another session, false if locked by this session.
  • access: public
boolean isForeignLock ()

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