Class Inx_Apiimpl_TriggerMailing_TriggerMailingImpl

Description
Variable Summary
mixed $data
Method Summary
static void convert (Inx_Apiimpl_SessionContext $sc,  $data, Inx_Apiimpl_TriggerMailing_TriggerMailingManagerImpl $oTriggerMailingManager)
Inx_Apiimpl_TriggerMailing_TriggerMailingImpl __construct (Inx_Apiimpl_SessionContext $sc, Inx_Apiimpl_TriggerMailing_TriggerMailingManagerImpl $oTriggerMailingManager, [ $data = null], [ $iListContextId = null], [ $iFeatureId = null], [Inx_Api_TriggerMailing_Descriptor_TriggerDescriptor $triggerDescriptor = null])
void activateSending ()
void approve ( $iApproverId,  $sComment)
void approveImmediately ( $sComment)
void checkLazyData ()
void commitUpdate ()
void deactivateSending ( $blStopActiveSending)
void denyApprove ( $iApproverId,  $sComment)
void findLastSending ()
void findSendings ()
void getFilderIds ()
void getFilterId ()
void getId ()
void getLockTicket ()
void getMailingState ()
void getName ()
void getNextSending ()
void getPriority ()
void getSubject ()
void getTriggerState ()
void getTriggerType ()
void isActive ()
void isLocked ()
void lock ()
void reload ()
void requestEscalationApproval ( $sEscalationDate,  $sDeadline,  $approverIds,  $recipientIds,  $blIsTestRecipient,  $sLocale)
void requestIdenticalApproval ( $sDeadline,  $approverIds,  $recipientIds,  $blIsTestRecipient,  $sLocale)
void revokeApproval ([ $sComment = null])
void sendTestMail ( $sTestAddress,  $iRecipientId)
void sendTestMailWithTestprofile ( $sTestAddress,  $iTestprofileId)
void setContentHandler ( $sContentHandlerClazz)
void unlock ([ $blForceForeignLock = false])
void updateFilterId ( $iFilterId)
void updateFilterIds ( $filterIds, Inx_Api_TriggerMailing_FilterConcatenationType $concatinationType)
void updateName ( $sName)
void updatePriority ( $iPriority)
void updateSubject ( $sSubject)
Variables
mixed $changedAttrs (line 19)
  • access: public
mixed $contentHandler (line 17)
  • access: public
mixed $data (line 13)
  • access: public
Methods
static method convert (line 718)
  • access: public
static void convert (Inx_Apiimpl_SessionContext $sc,  $data, Inx_Apiimpl_TriggerMailing_TriggerMailingManagerImpl $oTriggerMailingManager)
Constructor __construct (line 22)
  • access: public
Inx_Apiimpl_TriggerMailing_TriggerMailingImpl __construct (Inx_Apiimpl_SessionContext $sc, Inx_Apiimpl_TriggerMailing_TriggerMailingManagerImpl $oTriggerMailingManager, [ $data = null], [ $iListContextId = null], [ $iFeatureId = null], [Inx_Api_TriggerMailing_Descriptor_TriggerDescriptor $triggerDescriptor = null])
activateSending (line 139)
  • access: public
void activateSending ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::activateSending()
Activates the sending of this trigger mailing. activated, so the mailing is ready to be sent. during the next dispatch cycle.
approve (line 218)
  • access: public
void approve ( $iApproverId,  $sComment)
  • $iApproverId
  • $sComment

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::approve()
Approves this trigger mailing for activation.
approveImmediately (line 191)
  • access: public
void approveImmediately ( $sComment)
  • $sComment

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::approveImmediately()
Approves this trigger mailing immediately, bypassing the normal approval process if necessary. process can only be bypassed if the API user has the according right.
checkLazyData (line 794)
void checkLazyData ()
checkWriteAccess (line 759)
void checkWriteAccess ()
commitUpdate (line 649)
  • access: public
void commitUpdate ()

Implementation of:
Inx_Api_BusinessObject::commitUpdate()
Passes all changes made since the last commit to the server.
deactivateSending (line 165)
  • access: public
void deactivateSending ( $blStopActiveSending)
  • $blStopActiveSending

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::deactivateSending()
Deactivates the sending of this trigger mailing. deactivated, so the mailing can not be sent. active sendings.
denyApprove (line 224)
  • access: public
void denyApprove ( $iApproverId,  $sComment)
  • $iApproverId
  • $sComment

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::denyApprove()
Denies the approval of this trigger mailing.
findLastSending (line 637)
  • access: public
void findLastSending ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::findLastSending()
Returns the Inx_Api_Sending_Sending object for the last sending of this trigger mailing, if any.
findSendings (line 631)
  • access: public
void findSendings ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::findSendings()
Returns an Inx_Api_ROBOResultSet containing all sendings of this trigger mailing.
getContentHandler (line 567)
  • access: public
void getContentHandler ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getContentHandler()
Returns the content handler, which contains the format-specific mail content.
getCreationDatetime (line 599)
  • access: public
void getCreationDatetime ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getCreationDatetime()
Returns the creation datetime of the trigger mailing.
getDeadlineDatetime (line 425)
  • access: public
void getDeadlineDatetime ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getDeadlineDatetime()
Returns the approval deadline datetime of this trigger mailing if the trigger mailing is in the state TriggerMailingState::APPROVAL_REQUESTED. may be returned.
getEscalationDatetime (line 419)
  • access: public
void getEscalationDatetime ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getEscalationDatetime()
Returns the approval escalation datetime of this trigger mailing if the trigger mailing is in the state TriggerMailingState::APPROVAL_REQUESTED and the approval process is escalating. state is not APPROVAL_REQUESTED or the approval process is identical, null may be returned.
getFilderIds (line 475)
  • access: public
void getFilderIds ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getFilderIds()
Returns the sending filters of this trigger mailing.
getFilterConcatinationType (line 488)
  • access: public
void getFilterConcatinationType ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getFilterConcatinationType()
Returns the sending filter concatenation type of this trigger mailing.
getFilterId (line 451)
  • access: public
void getFilterId ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getFilterId()
Returns one of the sending filters (probably the first) of this trigger mailing.
getId (line 643)
  • access: public
void getId ()

Implementation of:
Inx_Api_BusinessObject::getId()
Returns the unique identifier of this Inx_Api_BusinessObject.
getListContextId (line 431)
  • access: public
void getListContextId ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getListContextId()
Returns the id of the list context this trigger mailing belongs to.
getLockTicket (line 407)
  • access: public
void getLockTicket ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getLockTicket()
Returns the lock ticket.
getMailingState (line 383)
  • access: public
void getMailingState ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getMailingState()
Returns the state of this trigger mailing.
getModificationDatetime (line 413)
  • access: public
void getModificationDatetime ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getModificationDatetime()
Returns the last modification datetime.
getName (line 553)
  • access: public
void getName ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getName()
Returns the name of this trigger mailing.
getNextSending (line 625)
  • access: public
void getNextSending ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getNextSending()
Returns the date of the next sending of this trigger mailing.
getPriority (line 513)
  • access: public
void getPriority ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getPriority()
Returns the value of the X-Priority header.
getReplyToAddress (line 444)
  • access: public
void getReplyToAddress ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getReplyToAddress()
Returns the reply address of this trigger mailing.
getSenderAddress (line 437)
  • access: public
void getSenderAddress ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getSenderAddress()
Returns the sender address of this trigger mailing.
getSubject (line 539)
  • access: public
void getSubject ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getSubject()
Returns the subject of this trigger mailing.
getTriggerDescriptor (line 605)
  • access: public
void getTriggerDescriptor ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getTriggerDescriptor()
Returns the trigger descriptor of this trigger mailing. and all settings regarding the trigger.
getTriggerState (line 389)
  • access: public
void getTriggerState ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getTriggerState()
Returns the state of the trigger of this trigger mailing.
getTriggerType (line 619)
  • access: public
void getTriggerType ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::getTriggerType()
Returns the type of this trigger mailing.
isActive (line 395)
  • access: public
void isActive ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::isActive()
Returns a bool indicating whether this trigger mailing is active.
isLocked (line 401)
  • access: public
void isLocked ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::isLocked()
Checks if this trigger mailing is locked by a session, regardless of the lock owner.
lock (line 342)
  • access: public
void lock ()

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::lock()
Locks this TriggerMailing, so it cannot be locked by another session.
reload (line 688)
  • access: public
void reload ()

Implementation of:
Inx_Api_BusinessObject::reload()
Reloads this business object from the server.
requestEscalationApproval (line 257)
  • access: public
void requestEscalationApproval ( $sEscalationDate,  $sDeadline,  $approverIds,  $recipientIds,  $blIsTestRecipient,  $sLocale)
  • $sEscalationDate
  • $sDeadline
  • array $approverIds
  • array $recipientIds
  • $blIsTestRecipient
  • $sLocale

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::requestEscalationApproval()
Requests escalating approval for this trigger mailing. the escalation date expires without the first approver having approved the trigger mailing, the request is sent to the second approver. mailing, the request will be cancelled. the approval again.
requestIdenticalApproval (line 265)
  • access: public
void requestIdenticalApproval ( $sDeadline,  $approverIds,  $recipientIds,  $blIsTestRecipient,  $sLocale)
  • $sDeadline
  • array $approverIds
  • array $recipientIds
  • $blIsTestRecipient
  • $sLocale

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::requestIdenticalApproval()
Requests identical approval for this trigger mailing. requires both approvers to approve the trigger mailing. having approved the trigger mailing (and the other not reacted), the request will be cancelled. approve it, the trigger mailing creator will have to request the approval again.
revokeApproval (line 315)
  • access: public
void revokeApproval ([ $sComment = null])
  • $sComment

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::revokeApproval()
Revokes the approval for this trigger mailing.
sendTestMail (line 61)
  • access: public
void sendTestMail ( $sTestAddress,  $iRecipientId)
  • $sTestAddress
  • $iRecipientId

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::sendTestMail()
Sends this trigger mailing to the specified test address. email content, creating a preview of the trigger mailing.
sendTestMailWithTestprofile (line 100)
  • access: public
void sendTestMailWithTestprofile ( $sTestAddress,  $iTestprofileId)
  • $sTestAddress
  • $iTestprofileId

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::sendTestMailWithTestprofile()
Sends this trigger mailing to the specified test address. the email content, creating a preview of the trigger mailing.
setContentHandler (line 580)
  • access: public
void setContentHandler ( $sContentHandlerClazz)
  • $sContentHandlerClazz

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::setContentHandler()
Creates a new content handler.
unlock (line 367)
  • access: public
void unlock ([ $blForceForeignLock = false])
  • $blForceForeignLock

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::unlock()
Releases the lock of this TriggerMailing.
updateFilterId (line 462)
  • access: public
void updateFilterId ( $iFilterId)
  • $iFilterId

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::updateFilterId()
Sets the given filter as the only sending filter of this trigger mailing.
updateFilterIds (line 501)
  • access: public
void updateFilterIds ( $filterIds, Inx_Api_TriggerMailing_FilterConcatenationType $concatinationType)

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::updateFilterIds()
Sets the filters used as the sending filters of this trigger mailing, concatenated using the given concatenation type.
  • FilterConcatenationType::AND(),
  • FilterConcatenationType::OR() or
  • FilterConcatenationType::NOT_IN()
For more information on Filters, see the Inx_Api_Filter_Filter documentation.
updateName (line 559)
  • access: public
void updateName ( $sName)
  • $sName

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::updateName()
Sets the name of this trigger mailing.
updatePriority (line 520)
  • access: public
void updatePriority ( $iPriority)
  • $iPriority

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::updatePriority()
Sets the value of the X-Priority header.
updateSubject (line 545)
  • access: public
void updateSubject ( $sSubject)
  • $sSubject

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::updateSubject()
Sets the subject of this trigger mailing.
updateTriggerDescriptor (line 611)
  • access: public
void updateTriggerDescriptor (Inx_Api_TriggerMailing_Descriptor_TriggerDescriptor $triggerDescriptor)

Implementation of:
Inx_Api_TriggerMailing_TriggerMailing::updateTriggerDescriptor()
Updates the trigger descriptor of this trigger mailing.

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