Interface Inx_Api_ManipulationRowSet

Description

Inx_Api_ManipulationRowSet provides a common base for row sets which enable the manipulation of the contained data. data in the currently selected row.

Inx_Api_ManipulationRowSet provides a common base for row sets which enable the manipulation of the contained data. An implementation of Inx_Api_ManipulationRowSet will provide a set of update methods which manipulate the data in the currently selected row. All row changes except for the deleteRow() and deleteRows() methods usually require a call of commitRowUpdate() to be reflected on the server. Any uncommitted changes will be lost once the Inx_Api_ManipulationRowSet is closed. However, calling

on deleted rows will trigger an Inx_Api_DataException, as the recipient in the current row no longer exists.

Note: To safely abandon all changes of the current row, use the rollbackRowUpdate() method. This will prevent any changes to the current row from being committed through commitRowUpdate(). Be aware that rollbackRowUpdate will only undo uncommitted changes to the current row. So, once you called commitRowUpdate() there is "no way back".

  • author: chge, 16.05.2013
  • since: API 1.11.1

Located in /Api/ManipulationRowSet.php (line 20)

Inx_Api_InxRowSet
   |
   --Inx_Api_ManipulationRowSet
Direct descendents
Class Description
Inx_Api_InsertionRowSet Inx_Api_InsertionRowSet provides a common base for all row set which enable the insertion of rows. new row you have to do the following steps:
  1. Call moveToInsertRow()
  2. Provide the row data using the offered update methods
  3. Call commitRowUpdate()
The insert row is a special row that acts as a staging area for an object to be inserted. Inx_Api_InsertionRowSet provides a set of update methods which can be used to construct this new object.
Method Summary
void commitRowUpdate ()
void deleteRow ()
void deleteRows (Inx_Api_IndexSelection $selection)
bool isRowDeleted ()
Methods
commitRowUpdate (line 87)

Updates the underlying object on the server with the new contents of the current row of this row set.

Updates the underlying object on the server with the new contents of the current row of this row set.
Note: Not all of the Exceptions listed in the exceptions section are thrown by each implementation of ManipulationRowSet:

  • Inx_Api_Recipient_RecipientRowSet might throw:
    • Inx_Api_Recipient_BlackListException
    • Inx_Api_Recipient_IllegalValueException
    • Inx_Api_Recipient_DuplicateKeyException
    • Inx_Api_DataException
  • Inx_Api_Testprofiles_TestRecipientRowSet might throw:
    • Inx_Api_Recipient_IllegalValueException
    • Inx_Api_Recipient_DuplicateKeyException
    • Inx_Api_DataException
  • Inx_Api_Recipient_UnsubscriptionRecipientRowSet might throw:
    • Inx_Api_Recipient_BlackListException
    • Inx_Api_Recipient_IllegalValueException
    • Inx_Api_Recipient_DuplicateKeyException
    • Inx_Api_DataException

  • throws: Exception if the update failed.
  • throws: Inx_Api_Recipient_BlackListException if the email address is blocked by a blacklist entry.
  • throws: Inx_Api_Recipient_IllegalValueException if one of the attribute values is invalid.
  • throws: Inx_Api_DataException if the object was deleted or no object is selected (e.g. you forgot to call next()).
  • throws: Inx_Api_Recipient_DuplicateKeyException if the key value is already used.
  • access: public
void commitRowUpdate ()
deleteRow (line 27)

Deletes the current row from this row set. available). trigger an Inx_Api_DataException.

Deletes the current row from this row set. This method cannot be called when the cursor is on the insert row (if available). Do not call commitRowUpdate() after invoking this method, as this would trigger an Inx_Api_DataException.

  • access: public
void deleteRow ()
deleteRows (line 36)

Deletes the specified rows from this row set. affected row after invoking this method, as this would trigger an Inx_Api_DataException.

Deletes the specified rows from this row set. Do not call commitRowUpdate() on an affected row after invoking this method, as this would trigger an Inx_Api_DataException.

  • access: public
void deleteRows (Inx_Api_IndexSelection $selection)
isRowDeleted (line 45)

Reports whether the underlying object of the currently selected row is deleted or not.

Reports whether the underlying object of the currently selected row is deleted or not.

  • return: true if the underlying object of the currently selected row is deleted, false otherwise.
  • access: public
bool isRowDeleted ()
rollbackRowUpdate (line 95)

Reverts the updates made to the current row in this row set. several update methods to roll back the updates made to a row. commitRowUpdate has already been called, this method has no effect.

Reverts the updates made to the current row in this row set. This method may be called after calling one or several update methods to roll back the updates made to a row. If no updates have been made or commitRowUpdate has already been called, this method has no effect.

  • access: public
void rollbackRowUpdate ()

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:27 +0200 by phpDocumentor 1.3.2