Interface Inx_Api_Recipient_ReadOnlyRecipientRowSet

Description

  1. ReadOnlyRecipientRowSet
provides a common base for all row sets with the ability to retrieve recipient meta data (i. #getObject(Attribute).

  1. ReadOnlyRecipientRowSet
provides a common base for all row sets with the ability to retrieve recipient meta data (i.e. recipient attributes). Attribute values are retrieved by data type or in a generic way using #getObject(Attribute).

  • author: chge, 16.05.2013
  • since: API 1.11.1

Located in /Api/Recipient/ReadOnlyRecipientRowSet.php (line 10)

Inx_Api_InxRowSet
   |
   --Inx_Api_Recipient_ReadOnlyRecipientRowSet
Direct descendents
Class Description
Inx_Api_Recipient_RecipientManipulationRowSet Inx_Api_Recipient_RecipientManipulationRowSet provides a common base for row sets which enable the manipulation of recipients and their meta data (i.
Inx_Api_Recipient_UnsubscriptionRecipientRowSet An Inx_Api_Recipient_UnsubscriptionRecipientRowSet is best explained as a table of data representing a set of recipients, which is usually generated by executing a selection that queries unsubscribed recipients from the recipient context.
Inx_Api_Subscription_SubscriptionLogEntryRowSet An Inx_Api_Subscription_SubscriptionLogEntryRowSet can be used to determine whether recipients have been unsubscribed from or subscribed to a list.
Method Summary
Methods
getBoolean (line 21)

Retrieves the value of the designated attribute in the current row of this row set as a Boolean.

Retrieves the value of the designated attribute in the current row of this row set as a Boolean.

  • return: the attribute value as bool. May return null.
  • exception: Inx_Api_IllegalStateException if the attribute is not of type Boolean.
  • exception: Inx_Api_DataException if the recipient was deleted or no recipient is selected (e.g. you forgot to call next()).
  • access: public
bool getBoolean (Inx_Api_Recipient_Attribute $attr)
getContext (line 112)

Retrieves the Inx_Api_Recipient_RecipientContext used to fetch the recipient attributes.

Retrieves the Inx_Api_Recipient_RecipientContext used to fetch the recipient attributes.

  • return: the RecipientContext used to fetch the recipient attributes.
  • access: public
getDate (line 57)

Retrieves the value of the designated attribute in the current row of this row set as a Date.

Retrieves the value of the designated attribute in the current row of this row set as a Date.

  • return: the attribute value as Date (ISO-8601 formatted date string). May return null.
  • exception: Inx_Api_IllegalStateException if the attribute is not of type Date.
  • exception: Inx_Api_DataException if the recipient was deleted or no recipient is selected (e.g. you forgot to call next()).
  • access: public
string getDate (Inx_Api_Recipient_Attribute $attr)
getDatetime (line 81)

Retrieves the value of the designated attribute in the current row of this row set as a Datetime.

Retrieves the value of the designated attribute in the current row of this row set as a Datetime.

  • return: the attribute value as Datetime (ISO-8601 formatted datetime string). May return null.
  • exception: Inx_Api_IllegalStateException if the attribute is not of type Datetime.
  • exception: Inx_Api_DataException if the recipient was deleted or no recipient is selected (e.g. you forgot to call next()).
  • access: public
string getDatetime (Inx_Api_Recipient_Attribute $attr)
getDouble (line 45)

Retrieves the value of the designated attribute in the current row of this row set as a Double.

Retrieves the value of the designated attribute in the current row of this row set as a Double.

  • return: the attribute value as double. May return null.
  • exception: Inx_Api_IllegalStateException if the attribute is not of type Double.
  • exception: Inx_Api_DataException if the recipient was deleted or no recipient is selected (e.g. you forgot to call next()).
  • access: public
float getDouble (Inx_Api_Recipient_Attribute $attr)
getInteger (line 33)

Retrieves the value of the designated attribute in the current row of this row set as an Integer.

Retrieves the value of the designated attribute in the current row of this row set as an Integer.

  • return: the attribute value as int. May return null.
  • exception: Inx_Api_IllegalStateException if the attribute is not of type Integer.
  • exception: Inx_Api_DataException if the recipient was deleted or no recipient is selected (e.g. you forgot to call next()).
  • access: public
int getInteger (Inx_Api_Recipient_Attribute $attr)
getMetaData (line 120)

Retrieves the Inx_Api_Recipient_RecipientMetaData object used to fetch recipient attributes.

Retrieves the Inx_Api_Recipient_RecipientMetaData object used to fetch recipient attributes.

  • return: the RecipientMetaData object used to fetch recipient attributes.
  • access: public
getObject (line 104)

Retrieves the value of the designated attribute in the current row of this row set as an Object.

Retrieves the value of the designated attribute in the current row of this row set as an Object.

  • return: the attribute value. May return null.
  • exception: Inx_Api_DataException if the recipient was deleted or no recipient is selected (e.g. you forgot to call next()).
  • access: public
mixed getObject (Inx_Api_Recipient_Attribute $attr)
getString (line 93)

Retrieves the value of the designated attribute in the current row of this row set as a String.

Retrieves the value of the designated attribute in the current row of this row set as a String.

  • return: the attribute value as string. May return null.
  • exception: Inx_Api_IllegalStateException if the attribute is not of type String.
  • exception: Inx_Api_DataException if the recipient was deleted or no recipient is selected (e.g. you forgot to call next()).
  • access: public
string getString (Inx_Api_Recipient_Attribute $attr)
getTime (line 69)

Retrieves the value of the designated attribute in the current row of this row set as a Time.

Retrieves the value of the designated attribute in the current row of this row set as a Time.

  • return: the attribute value as Time (ISO-8601 formatted time string). May return null.
  • exception: Inx_Api_IllegalStateException if the attribute is not of type Time.
  • exception: Inx_Api_DataException if the recipient was deleted or no recipient is selected (e.g. you forgot to call next()).
  • access: public
string getTime (Inx_Api_Recipient_Attribute $attr)

Inherited Methods

Inherited From Inx_Api_InxRowSet

Inx_Api_InxRowSet::afterLastRow()
Inx_Api_InxRowSet::beforeFirstRow()
Inx_Api_InxRowSet::close()
Inx_Api_InxRowSet::getRow()
Inx_Api_InxRowSet::getRowCount()
Inx_Api_InxRowSet::next()
Inx_Api_InxRowSet::previous()
Inx_Api_InxRowSet::setRow()

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