Class Inx_Api_Property_ApprovalPropertyValue

Description

The Inx_Api_Property_ApprovalPropertyValue is a wrapper class for the approval property values.

The Inx_Api_Property_ApprovalPropertyValue is a wrapper class for the approval property values. This value determines if and how mailings shall be approved and by whom. An Inx_Api_Property_ApprovalPropertyValue therefore consists of three parts which define the approval strategy:

  • The approval type: Defines if and how mailings shall be approved.
  • The primary approver: Approver that will be involved in all approval types immediately.
  • The secondary approver: Approver that will only get involved in certain conditions.
If and how the approvers will get involved is determined from the approval type. The possible values for the approval type are:
  • APPROVAL_TYPE_OFF: Approval is completely turned off. No approver will get involved, the editor is the only one responsible for the correctness of the mailing content.
  • APPROVAL_TYPE_SYSTEM: The approval type is inherited from the system list.
  • APPROVAL_TYPE_IDENTICAL: Both approvers will get involved immediately. Only one of them has to approve the mailing.
  • APPROVAL_TYPE_ESCALATION: At first, only the primary approver will be involved. If the escalation date expires without the primary approver having approved the mailing, the secondary approver will get involved.

To convert an Inx_Api_Property_ApprovalPropertyValue into the internal representation needed for the approval property, use the Inx_Api_Property_PropertyFormatter::createApprovalPropertyValue($oApprovalPropertyValue) method. To convert the internal representation into an Inx_Api_Property_ApprovalPropertyValue object, use the Inx_Api_Property_PropertyFormatter::parseApprovalPropertyValue($oProperty) method.

  • version: $Revision: 10520 $ $Date: 2008-09-12 14:40:48 +0200 (Fr, 12 Sep 2008) $ $Author: sbn $
  • see: APPROVAL_ACTIVE
  • see: com.inxmail.xpro.api.property.PropertyFormatter
  • since: API 1.6.0

Located in /Api/Property/ApprovalPropertyValue.php (line 43)


	
			
Class Constant Summary
Method Summary
Inx_Api_Property_ApprovalPropertyValue __construct (int $approvalType, int $primaryApproverId, int $secondaryApproverId)
Methods
Constructor __construct (line 95)

Creates an Inx_Api_Property_ApprovalPropertyValue instance with the given approval type, primary approver and secondary approver.

Creates an Inx_Api_Property_ApprovalPropertyValue instance with the given approval type, primary approver and secondary approver. If the approval type is APPROVAL_TYPE_OFF or APPROVAL_TYPE_SYSTEM, no approvers need to be defined. In that case use -1 as the id of both approvers.

  • access: public
Inx_Api_Property_ApprovalPropertyValue __construct (int $approvalType, int $primaryApproverId, int $secondaryApproverId)
  • int $approvalType: the approval type. May be one of:
    • APPROVAL_TYPE_OFF
    • APPROVAL_TYPE_SYSTEM
    • APPROVAL_TYPE_IDENTICAL
    • APPROVAL_TYPE_ESCALATION
  • int $primaryApproverId: the id of the primary approver, or -1 if none is needed.
  • int $secondaryApproverId: the id of the secondary approver, or -1 if none is needed.
getApprovalType (line 114)

Returns the type of the approval process, also indicates if the process is deactivated.

Returns the type of the approval process, also indicates if the process is deactivated.

  • return: the approval type. May be one of:
    • APPROVAL_TYPE_OFF
    • APPROVAL_TYPE_SYSTEM
    • APPROVAL_TYPE_IDENTICAL
    • APPROVAL_TYPE_ESCALATION
  • access: public
int getApprovalType ()
getPrimaryApproverId (line 125)

Returns the id of the primary approver.

Returns the id of the primary approver.

  • return: the id of the primary approver.
  • access: public
int getPrimaryApproverId ()
getSecondaryApproverId (line 136)

Returns the id of the secondary approver.

Returns the id of the secondary approver.

  • return: the id of the secondary approver.
  • access: public
int getSecondaryApproverId ()
Class Constants
APPROVAL_TYPE_ESCALATION = 2 (line 69)

Approval type used for the escalating approval process.

Approval type used for the escalating approval process. At first, only the primary approver will be involved. If the escalation date expires without the primary approver having approved the mailing, the secondary approver will get involved.

APPROVAL_TYPE_IDENTICAL = 3 (line 76)

Approval type used for the identical approval process.

Approval type used for the identical approval process. Both approvers will get involved immediately. Only one of them has to approve the mailing.

APPROVAL_TYPE_OFF = 0 (line 55)

Approval type used for deactivating the approval process.

Approval type used for deactivating the approval process. No approver will get involved, the editor is the only one responsible for the correctness of the mailing content.

APPROVAL_TYPE_SYSTEM = 1 (line 61)

Approval type used to inherit the type from the system approval property.

Approval type used to inherit the type from the system approval property. If this type is used in the system list, the system approval property will be set to APPROVAL_TYPE_OFF.

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