Class Inx_Apiimpl_Recipient_RecipientContextImpl

Description

Implements interfaces:

The implementation of

  1. RecipientContext
<P>Copyright (c) 2005 Inxmail GmbH.

The implementation of

  1. RecipientContext
Copyright (c) 2005 Inxmail GmbH. All Rights Reserved.

  • version: $Revision: 4690 $ $Date: 2006-09-20 07:24:45 +0000 (Mi, 20 Sep 2006) $ $Author: bgn $

Located in /Apiimpl/Recipient/RecipientContextImpl.php (line 9)

Inx_Apiimpl_RemoteObject
   |
   --Inx_Apiimpl_Recipient_RecipientContextImpl
Variable Summary
Method Summary
Inx_Apiimpl_Recipient_RecipientContextImpl __construct ( $oSessionContext,  $oRecipientContextData)
void close ()
RecipientData createNewRecipientData ()
RecipientUpdate createRecipientUpdate (RecipientData $oRd, array $aChangedAttrFlag)
RecipientRowSet createRowSet ()
void findAllByKey ( $sKey)
void findAllByKeys ( $aKeys)
void findByIds ( $aRecipientIds)
void findByKey ( $sKey)
void findByKeys ( $aKeys)
void findBySending ( $iSendingId)
Attribute getAttribute ( $iAttributeId)
Iterator getAttributeIterator ()
Attribute getEmailAttribute ()
Attribute getHardbounceAttribute ()
Attribute getIdAttribute ()
Attribute getKeyAttribute ()
Attribute getUserAttribute ( $sAttributeName)
void initAllAttributes ( $oRCData)
boolean isKeyUnique ()
boolean isUpToDate ()
Inx_Api_Recipient_RecipientRowSet select ([Inx_Api_List_ListContext $list = null], [Inx_Api_Filter_Filter $oFilter = null], [ $sAdditionalFilter = null], [Inx_Api_Recipient_Attribute $oOrderAttribute = null], [ $iOrderType = null])
void selectUnsubscriber (Inx_Api_List_ListContext $oList, [Inx_Api_Filter_Filter $oFilter = null], [ $sAdditionalFilter = null], [Inx_Api_Recipient_Attribute $oOrderAttribute = null], [ $iOrderType = null])
boolean setAttributeValue (Inx_Api_Recipient_Attribute $attr,  $newValue)
Variables
mixed $_aAttributes = array() (line 23)

Attribute meta data (inclusive id attribute)

Attribute meta data (inclusive id attribute)

  • access: protected
mixed $_aAttrIdMap = array() (line 18)
  • access: protected
mixed $_aAttrNameMap = array() (line 16)
  • access: protected
mixed $_blKeyUnique (line 20)
  • access: protected
mixed $_iBooleanAttrCount (line 36)
  • access: protected
mixed $_iDateAttrCount (line 39)
  • access: protected
mixed $_iDatetimeAttrCount (line 41)
  • access: protected
mixed $_iDoubleAttrCount (line 38)
  • access: protected
mixed $_iIntegerAttrCount (line 37)
  • access: protected
mixed $_iStringAttrCount (line 35)
  • access: protected
mixed $_iTimeAttrCount (line 40)
  • access: protected
mixed $_iUpdAttrCount (line 44)

Count of updateable attributes (without id attribute)

Count of updateable attributes (without id attribute)

  • access: protected
mixed $_oEmailAttr (line 29)
  • access: protected
mixed $_oHardbounceAttr (line 33)
  • access: protected
mixed $_oIdAttr (line 25)
  • access: protected
mixed $_oKeyAttr (line 27)
  • access: protected
mixed $_oLastModificationAttr (line 31)
  • access: protected
mixed $_oService (line 12)
  • access: protected
mixed $_oServiceUnsubscription (line 14)
  • access: protected
Methods
Constructor __construct (line 47)
  • access: public
Inx_Apiimpl_Recipient_RecipientContextImpl __construct ( $oSessionContext,  $oRecipientContextData)
  • $oSessionContext
  • $oRecipientContextData

Redefinition of:
Inx_Apiimpl_RemoteObject::__construct()
close (line 323)
  • see: close()
  • access: public
void close ()

Implementation of:
Inx_Api_Recipient_RecipientContext::close()
Closes this recipient context and releases any resources associated with it.
createBatchChannel (line 304)
  • see: createBatchChannel(com.inxmail.xpro.api.recipient.Attribute)
  • access: public
Inx_Api_Recipient_BatchChannel createBatchChannel ([Inx_Api_Recipient_Attribute $oSelectAttribute = null])

Implementation of:
Inx_Api_Recipient_RecipientContext::createBatchChannel()
Creates an Inx_Api_Recipient_BatchChannel for fast recipient data manipulation with an optional alternative 'key attribute' to select the recipient.
createNewRecipientData (line 342)
  • access: public
RecipientData createNewRecipientData ()
createRecipientUpdate (line 370)
  • access: public
RecipientUpdate createRecipientUpdate (RecipientData $oRd, array $aChangedAttrFlag)
  • RecipientData $oRd
  • array $aChangedAttrFlag: changedAttrFlag
createRowSet (line 259)
  • see: createRowSet()
  • access: public
RecipientRowSet createRowSet ()

Implementation of:
Inx_Api_Recipient_RecipientContext::createRowSet()
Returns an empty Inx_Api_Recipient_RecipientRowSet.
findAllByKey (line 132)
  • access: public
void findAllByKey ( $sKey)
  • $sKey

Implementation of:
Inx_Api_Recipient_RecipientContext::findAllByKey()
Returns an Inx_Api_Recipient_RecipientRowSet containing all recipients with the specified key.
findAllByKeys (line 162)
  • access: public
void findAllByKeys ( $aKeys)
  • $aKeys

Implementation of:
Inx_Api_Recipient_RecipientContext::findAllByKeys()
Returns an Inx_Api_Recipient_RecipientRowSet containing all recipients with the specified keys.
findByIds (line 177)
  • access: public
void findByIds ( $aRecipientIds)
  • $aRecipientIds

Implementation of:
Inx_Api_Recipient_RecipientContext::findByIds()
Returns an Inx_Api_Recipient_RecipientRowSet containing all recipients specified by the given IDs.
findByKey (line 117)
  • access: public
void findByKey ( $sKey)
  • $sKey

Implementation of:
Inx_Api_Recipient_RecipientContext::findByKey()
Returns an Inx_Api_Recipient_RecipientRowSet containing exactly one recipient: the one with the specified key.
findByKeys (line 147)
  • access: public
void findByKeys ( $aKeys)
  • $aKeys

Implementation of:
Inx_Api_Recipient_RecipientContext::findByKeys()
Returns an Inx_Api_Recipient_RecipientRowSet containing all recipients with the specified keys.
findBySending (line 192)
  • access: public
void findBySending ( $iSendingId)
  • $iSendingId

Implementation of:
Inx_Api_Recipient_RecipientContext::findBySending()
Returns an Inx_Api_Recipient_RecipientRowSet containing all recipients associated with the specified sending.
getAttribute (line 543)
  • see: getAttribute(int)
  • throws: Inx_Api_Recipient_AttributeNotFoundException
  • access: public
Attribute getAttribute ( $iAttributeId)
  • $iAttributeId

Implementation of:
Inx_Api_Recipient_RecipientMetaData::getAttribute()
Returns the attribute specified by the given id.
getAttributeCount (line 559)
  • see: getAttributeCount()
  • access: public
int getAttributeCount ()

Implementation of:
Inx_Api_Recipient_RecipientMetaData::getAttributeCount()
Returns the number of attributes.
getAttributeIterator (line 569)
Iterator getAttributeIterator ()

Implementation of:
Inx_Api_Recipient_RecipientMetaData::getAttributeIterator()
Returns an Inx_Apiimpl_Recipient_RecipientContextImpl_AttributeIterator over the attributes in this meta data.
getEmailAttribute (line 482)
  • see: getEmailAttribute()
  • access: public
Attribute getEmailAttribute ()

Implementation of:
Inx_Api_Recipient_RecipientMetaData::getEmailAttribute()
Returns the email attribute.
getHardbounceAttribute (line 501)
  • see: getHardbounceAttribute()
  • access: public
Attribute getHardbounceAttribute ()

Implementation of:
Inx_Api_Recipient_RecipientMetaData::getHardbounceAttribute()
Returns the hardbounce attribute.
getIdAttribute (line 462)
  • see: getIdAttribute()
  • access: public
Attribute getIdAttribute ()

Implementation of:
Inx_Api_Recipient_RecipientMetaData::getIdAttribute()
Returns the id attribute.
getKeyAttribute (line 472)
  • see: getKeyAttribute()
  • access: public
Attribute getKeyAttribute ()

Implementation of:
Inx_Api_Recipient_RecipientMetaData::getKeyAttribute()
Returns the key attribute.
getLastModificationAttribute (line 492)
  • see: getLastModificationAttribute()
  • access: public
Attribute getLastModificationAttribute ()

Implementation of:
Inx_Api_Recipient_RecipientMetaData::getLastModificationAttribute()
Returns the last modification attribute.
getMetaData (line 295)
  • see: getMetaData()
  • access: public

Implementation of:
Inx_Api_Recipient_RecipientContext::getMetaData()
Retrieves an Inx_Api_Recipient_RecipientMetaData object that contains meta data about the recipients represented by this Inx_Api_Recipient_RecipientMetaData object.
getSubscriptionAttribute (line 528)
  • see: getSubscriptionAttribute(com.inxmail.xpro.api.list.ListContext)
  • throws: Inx_Api_Recipient_AttributeNotFoundException
  • access: public
Attribute getSubscriptionAttribute (Inx_Api_List_ListContext $oList)

Implementation of:
Inx_Api_Recipient_RecipientMetaData::getSubscriptionAttribute()
Returns the subscription attribute for the specified list.
getUpdateableAttributeCount (line 452)

Enter description here.

Enter description here...

  • access: public
int getUpdateableAttributeCount ()
getUserAttribute (line 511)
  • see: getUserAttribute(java.lang.String)
  • throws: Inx_Api_Recipient_AttributeNotFoundException
  • access: public
Attribute getUserAttribute ( $sAttributeName)
  • $sAttributeName

Implementation of:
Inx_Api_Recipient_RecipientMetaData::getUserAttribute()
Returns the attribute specified by the given name.
initAllAttributes (line 575)
  • access: protected
void initAllAttributes ( $oRCData)
  • stdClass $oRCData
isKeyUnique (line 333)
  • see: isKeyUnique()
  • access: public
boolean isKeyUnique ()

Implementation of:
Inx_Api_Recipient_RecipientContext::isKeyUnique()
Determines if the key is unique. you need not worry about this method.
isUpToDate (line 278)
  • see: isUpToDate()
  • access: public
boolean isUpToDate ()

Implementation of:
Inx_Api_Recipient_RecipientContext::isUpToDate()
Checks whether or not this Inx_Api_Recipient_RecipientContext is up to date.
select (line 80)
  • see: select()
  • throws: SelectException
  • access: public
Inx_Api_Recipient_RecipientRowSet select ([Inx_Api_List_ListContext $list = null], [Inx_Api_Filter_Filter $oFilter = null], [ $sAdditionalFilter = null], [Inx_Api_Recipient_Attribute $oOrderAttribute = null], [ $iOrderType = null])

Implementation of:
Inx_Api_Recipient_RecipientContext::select()
Returns an Inx_Api_Recipient_RecipientRowSet containing all recipients that are members of the given list and match the given filter and additional filter statement, ordered by the given attribute and order type.
selectUnsubscriber (line 207)
  • access: public
void selectUnsubscriber (Inx_Api_List_ListContext $oList, [Inx_Api_Filter_Filter $oFilter = null], [ $sAdditionalFilter = null], [Inx_Api_Recipient_Attribute $oOrderAttribute = null], [ $iOrderType = null])

Implementation of:
Inx_Api_Recipient_RecipientContext::selectUnsubscriber()
Returns an Inx_Api_Recipient_UnsubscriptionRecipientRowSet containing all recipients that have been unsubscribed from the given list and match the given filter and additional filter statement, ordered by the given attribute and order type.
setAttributeValue (line 239)
  • see: setAttributeValue(com.inxmail.xpro.api.recipient.Attribute, java.lang.Object)
  • access: public
boolean setAttributeValue (Inx_Api_Recipient_Attribute $attr,  $newValue)

Implementation of:
Inx_Api_Recipient_RecipientContext::setAttributeValue()
Sets the specified attribute value to all recipients in the system.

Inherited Methods

Inherited From Inx_Apiimpl_RemoteObject

Inx_Apiimpl_RemoteObject::__construct()
Inx_Apiimpl_RemoteObject::_createCxt()
Inx_Apiimpl_RemoteObject::_isReleased()
Inx_Apiimpl_RemoteObject::_notify()
Inx_Apiimpl_RemoteObject::_refId()
Inx_Apiimpl_RemoteObject::_release()
Inx_Apiimpl_RemoteObject::_remoteRef()
Inx_Apiimpl_RemoteObject::_sessionId()

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