Class Inx_Api_Recipient_RecipientState

Description

The Inx_Api_Recipient_RecipientState enumeration defines the states of a recipient.

The Inx_Api_Recipient_RecipientState enumeration defines the states of a recipient. These states are used in query results to indicate whether the associated recipient is known and still available. There are three possible values:

  • UNKNOWN: Used if the recipient (or its state) is unknown. This can have various reasons:
    • The recipient ID refers to an invalid recipient (e.g. ID = 0)
    • No Inx_Api_Recipient_RecipientContext was provided in the query
    • No Inx_Api_Recipient_Attributes were fetched in the query
  • EXISTENT: Used if the recipient is known and active.
  • DELETED: Used if the recipient is known but was deleted.

  • author: chge, 20.11.2012

Located in /Api/Recipient/RecipientState.php (line 20)


	
			
Method Summary
Methods
static method byId (line 102)

Returns the Inx_Api_Recipient_RecipientState corresponding to the given id.

Returns the Inx_Api_Recipient_RecipientState corresponding to the given id. If the id is unknown, the UNKNOWN state will be returned. The ID is used for transmission purposes and should not be used inside client code.

  • return: the RecipientState corresponding to the given ID.
  • access: public
static Inx_Api_Recipient_RecipientState byId (int $iId)
  • int $iId: the ID of the RecipientState to retrieve.
static method DELETED (line 65)

Used if the recipient is known but was deleted.

Used if the recipient is known but was deleted.

  • return: the deleted state.
  • access: public
static method EXISTENT (line 52)

Used if the recipient is known and active.

Used if the recipient is known and active.

  • return: the existent state.
  • access: public
static method UNKNOWN (line 39)

Used if the recipient (or its state) is unknown.

Used if the recipient (or its state) is unknown. This can have various reasons:

  • The recipient ID refers to an invalid recipient (e.g. ID = 0)
  • No Inx_Api_Recipient_RecipientContext was provided in the query
  • No Inx_Api_Recipient_Attributes were fetched in the query

  • return: the unknown state.
  • access: public
static method values (line 119)

Returns an array containing all available RecipientStates including UNKNOWN.

Returns an array containing all available RecipientStates including UNKNOWN.

  • return: an array containing all available RecipientStates including UNKNOWN.
  • access: public
static array values ()
getId (line 88)

Returns the ID of this Inx_Api_Recipient_RecipientState.

Returns the ID of this Inx_Api_Recipient_RecipientState. The ID is used for transmission purposes and should not be used inside client code.

  • return: the ID of this RecipientState.
  • access: public
int getId ()

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