Class Inx_Api_TriggerMailing_TriggerMailingState

Description

The Inx_Api_TriggerMailing_TriggerMailingState enumeration defines the states in which a trigger mailing may transit. a trigger mailing may only be edited while it is in the DRAFT state, which is the initial state.

The Inx_Api_TriggerMailing_TriggerMailingState enumeration defines the states in which a trigger mailing may transit. Most operations on trigger mailings are only allowed while the mailing is in a specific state. For example, a trigger mailing may only be edited while it is in the DRAFT state, which is the initial state. If an operation is performed while in an illegal state, normally a TriggerMailingStateException will be raised. The only exception is the commitUpdate method, which cannot throw a state exception as it is inherited from Inx_Api_BusinessObject. Instead, commitUpdate will throw an Inx_Api_UpdateException stating that it is illegal to perform the action in the current state.

A note for programmers who are not familiar with the concept of enumerations: Enumerations or enumerated types are basically a fixed set of named values. They are usually used to define a couple of legitimate values in a specific context and serve a purpose similar to integer constants. The advantage of enumerations is, that you cannot specify any "weird" values because every value has to be an instance of the enumerated type. It is also possible to associate data or even behaviour (methods) with the values. PHP does not support such a language feature like Java and C# do. In most languages the named values are a sort of constant whose value is an instance of the enumerated type. In PHP a constant cannot contain a reference type. Therefore, we implemented enumerations as classes with private constructor and methods which return the named values. Be aware that the objects returned by the static methods are always the same object. That way it is possible to use the identity operator (===) on these objects and use them comfortably in switch statements.

Located in /Api/TriggerMailing/TriggerMailingState.php (line 32)


	
			
Method Summary
Methods
static method APPROVAL_REQUESTED (line 67)

State constant for the approval requested state. requested but not yet granted or denied. TriggerMailingStateException.

State constant for the approval requested state. This state indicates that the approval of a trigger mailing was requested but not yet granted or denied. The state constants are also used by the TriggerMailingStateException.

static Inx_Api_TriggerMailing_TriggerMailingState APPROVAL_REQUESTED ()
static method APPROVED (line 82)

State constant for the approved state. be sent.

State constant for the approved state. This state indicates that a trigger mailing was approved and is ready to be sent. The state constants are also used by the TriggerMailingStateException.

static method byId (line 149)

Returns the TriggerMailingState corresponding to the given id. UNKNOWN state will be returned. inside client code.

Returns the TriggerMailingState 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 TriggerMailingState corresponding to the given ID.
  • access: public
  • int $iId: the ID of the TriggerMailingState to retrieve.
static method DRAFT (line 51)

State constant for the draft state. constants are also used by the TriggerMailingStateException.

State constant for the draft state. The draft state is the initial state of a trigger mailing. The state constants are also used by the TriggerMailingStateException.

static method fromBitPattern (line 170)

Returns an array of TriggerMailingStates corresponding to the given bit pattern. bits will be ignored.

Returns an array of TriggerMailingStates corresponding to the given bit pattern. Unknown bits will be ignored. The bit pattern is used for transmission purposes and should not be used in client code.

  • return: an array of TriggerMailingStates corresponding to the given bit pattern.
  • access: public
static array fromBitPattern (int $iBitPattern)
  • int $iBitPattern: the bit pattern corresponding to the TriggerMailingStates to retrieve.
static method toBitPattern (line 193)

Returns the bit pattern corresponding to the given array of TriggerMailingStates. pattern is used for transmission purposes and should not be used in client code.

Returns the bit pattern corresponding to the given array of TriggerMailingStates. The bit pattern is used for transmission purposes and should not be used in client code.

  • return: the bit pattern corresponding to the given array of TriggerMailingStates.
  • access: public
static int toBitPattern ( $states)
  • array $states: the states to be converted into a bit pattern.
static method UNKNOWN (line 112)

State constant for an unknown state. constants are also used by the

  1. TriggerMailingStateException
.

State constant for an unknown state. This state indicates a version mismatch between API and server. The state constants are also used by the

  1. TriggerMailingStateException
.

static method USED (line 97)

State constant for the used state. once.

State constant for the used state. This state indicates that a trigger mailing was activated (used) at least once. The state constants are also used by the TriggerMailingStateException.

static method values (line 213)

Returns an array containing all available TriggerMailingStates including UNKNOWN.

Returns an array containing all available TriggerMailingStates including UNKNOWN.

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

Returns the ID of the TriggerMailingState. be used inside client code.

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

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

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