Interface Inx_Api_Recipient_RecipientManipulationRowSet

Description

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_RecipientManipulationRowSet provides a common base for row sets which enable the manipulation of recipients and their meta data (i.e. attributes). Inx_Api_Recipient_RecipientManipulationRowSet combines the capabilities of Inx_Api_Recipient_ReadOnlyRecipientRowSet (access to recipient meta data), Inx_Api_ManipulationRowSet (removal and basic committing / rollback mechanisms) and adds write access to recipient meta data.

The following snippet shows how to update the Lastname attribute in the fifth row of the Inx_Api_Recipient_RecipientManipulationRowSet object rrs and then uses the method commitRowUpdate to commit the changed data from which rrs was derived:

 $oAttribute = $oMetaData->getUserAttribute( 'Lastname' );
 $oRrs->setRow( 4 ); // moves the cursor to the fifth row of rrs
 // updates the 'Lastname' attribute of row 4 (fifth row) to be 'Smith'
 $oRrs->updateString( $oAttribute, 'Smith' );
 $oRrs->commitRowUpdate(); // updates the row in the data source

  • author: chge, 16.05.2013
  • since: API 1.11.1

Located in /Api/Recipient/RecipientManipulationRowSet.php (line 26)

Inx_Api_InxRowSet
   |
   --Inx_Api_Recipient_ReadOnlyRecipientRowSet
      |
      --Inx_Api_Recipient_RecipientManipulationRowSet
Direct descendents
Class Description
Inx_Api_Recipient_RecipientRowSet An Inx_Api_Recipient_RecipientRowSet is best explained as a table of data representing a set of recipients, which is usually generated by executing a selection that queries the recipient context.
Method Summary
void updateBoolean (Inx_Api_Recipient_Attribute $attr, bool $blValue)
void updateDate (Inx_Api_Recipient_Attribute $attr, string $sValue)
void updateDatetime (Inx_Api_Recipient_Attribute $attr, string $sValue)
void updateDouble (Inx_Api_Recipient_Attribute $attr, float $fValue)
void updateInteger (Inx_Api_Recipient_Attribute $attr, int $iValue)
void updateObject (Inx_Api_Recipient_Attribute $attr, mixed $oValue)
void updateString (Inx_Api_Recipient_Attribute $attr, string $sValue)
void updateTime (Inx_Api_Recipient_Attribute $attr, string $sValue)
Methods
updateBoolean (line 40)

Updates the designated attribute with a Boolean value. attribute values in the current row or the insert row. on the server; instead the commitRowUpdate method has to be called to commit the changes.

Updates the designated attribute with a Boolean value. The update methods are used to update attribute values in the current row or the insert row. The update methods do not update the underlying recipient on the server; instead the commitRowUpdate method has to be called to commit the changes.

  • 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
void updateBoolean (Inx_Api_Recipient_Attribute $attr, bool $blValue)
updateDate (line 83)

Updates the designated attribute with a Date value. attribute values in the current row or the insert row. on the server; instead the commitRowUpdate method has to be called to commit the changes.

Updates the designated attribute with a Date value. The update methods are used to update attribute values in the current row or the insert row. The update methods do not update the underlying recipient on the server; instead the commitRowUpdate method has to be called to commit the changes.

  • 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
void updateDate (Inx_Api_Recipient_Attribute $attr, string $sValue)
  • Inx_Api_Recipient_Attribute $attr: the designated attribute.
  • string $sValue: value the new attribute value. The date has to be passed as ISO-8601 formatted date string. May be null.
updateDatetime (line 113)

Updates the designated attribute with a Datetime value. attribute values in the current row or the insert row. on the server; instead the commitRowUpdate method has to be called to commit the changes.

Updates the designated attribute with a Datetime value. The update methods are used to update attribute values in the current row or the insert row. The update methods do not update the underlying recipient on the server; instead the commitRowUpdate method has to be called to commit the changes.

  • 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
void updateDatetime (Inx_Api_Recipient_Attribute $attr, string $sValue)
  • Inx_Api_Recipient_Attribute $attr: the designated attribute.
  • string $sValue: value the new attribute value. The datetime has to be passed as ISO-8601 formatted datetime string. May be null.
updateDouble (line 68)

Updates the designated attribute with a Double value. attribute values in the current row or the insert row. on the server; instead the commitRowUpdate method has to be called to commit the changes.

Updates the designated attribute with a Double value. The update methods are used to update attribute values in the current row or the insert row. The update methods do not update the underlying recipient on the server; instead the commitRowUpdate method has to be called to commit the changes.

  • 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
void updateDouble (Inx_Api_Recipient_Attribute $attr, float $fValue)
updateInteger (line 54)

Updates the designated attribute with a Integer value. attribute values in the current row or the insert row. on the server; instead the commitRowUpdate method has to be called to commit the changes.

Updates the designated attribute with a Integer value. The update methods are used to update attribute values in the current row or the insert row. The update methods do not update the underlying recipient on the server; instead the commitRowUpdate method has to be called to commit the changes.

  • 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
void updateInteger (Inx_Api_Recipient_Attribute $attr, int $iValue)
updateObject (line 140)

Updates the designated attribute with a Object value. attribute values in the current row or the insert row. on the server; instead the commitRowUpdate method has to be called to commit the changes.

Updates the designated attribute with a Object value. The update methods are used to update attribute values in the current row or the insert row. The update methods do not update the underlying recipient on the server; instead the commitRowUpdate method has to be called to commit the changes.

  • exception: Inx_Api_DataException if the recipient was deleted or no recipient is selected (e.g. you forgot to call next()).
  • access: public
void updateObject (Inx_Api_Recipient_Attribute $attr, mixed $oValue)
updateString (line 127)

Updates the designated attribute with a string value. attribute values in the current row or the insert row. on the server; instead the commitRowUpdate method has to be called to commit the changes.

Updates the designated attribute with a string value. The update methods are used to update attribute values in the current row or the insert row. The update methods do not update the underlying recipient on the server; instead the commitRowUpdate method has to be called to commit the changes.

  • 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
void updateString (Inx_Api_Recipient_Attribute $attr, string $sValue)
updateTime (line 98)

Updates the designated attribute with a Time value. attribute values in the current row or the insert row. on the server; instead the commitRowUpdate method has to be called to commit the changes.

Updates the designated attribute with a Time value. The update methods are used to update attribute values in the current row or the insert row. The update methods do not update the underlying recipient on the server; instead the commitRowUpdate method has to be called to commit the changes.

  • 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
void updateTime (Inx_Api_Recipient_Attribute $attr, string $sValue)
  • Inx_Api_Recipient_Attribute $attr: the designated attribute.
  • string $sValue: value the new attribute value. The time has to be passed as ISO-8601 formatted time string. May be null.

Inherited Methods

Inherited From Inx_Api_Recipient_ReadOnlyRecipientRowSet

Inx_Api_Recipient_ReadOnlyRecipientRowSet::getBoolean()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getContext()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getDate()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getDatetime()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getDouble()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getInteger()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getMetaData()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getObject()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getString()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getTime()

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