Interface Inx_Api_BOResultSet

Description

An Inx_Api_BOResultSet is effectively a list of Inx_Api_BusinessObjects.

An Inx_Api_BOResultSet is effectively a list of Inx_Api_BusinessObjects. The result set can be used to browse through this list, and to remove elements of the list. As of Inxmail Professional API 1.11.1, Inx_Api_BOResultSet implements Iterator. This enables you to use a for-each loop on an Inx_Api_BOResultSet.

<strong>Note:</strong> An Inx_Api_BOResultSet object <strong>must</strong> be closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects.

The following snippet demonstrates the preferable way to iterate over a Inx_Api_BOResultSet, as of Inxmail Professional API 1.11.1:

 $oMailings = $oSession->getMailingManager()->selectAll();

 foreach( $oMailings as $oMailing )
 {
  echo 'Mailing: ' . $oMailing->getName() . '<br>';
 }

 $oMailings->close();

  • version: $Revision: 9497 $ $Date: 2007-12-19 17:03:25 +0200 (Tr, 19 Grd 2007) $ $Author: aurimas $
  • see: Inx_Api_ROBOResultSet

Located in /Api/BOResultSet.php (line 33)

Iterator
   |
   --Inx_Api_BOResultSet
Method Summary
void close ()
Inx_Api_BusinessObject get (int $iIndex)
boolean remove (Inx_Api_IndexSelection $oSelection)
int size ()
Methods
close (line 72)

Closes this result set and releases any resources associated with the result set.

Closes this result set and releases any resources associated with the result set. An Inx_Api_BOResultSet object <strong>must</strong> be closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects.

  • access: public
void close ()
get (line 43)

Returns the Inx_Api_BusinessObject with the specified index.

Returns the Inx_Api_BusinessObject with the specified index.

  • return: the Inx_Api_BusinessObject with the specified index.
  • throws: Inx_Api_DataException if no Inx_Api_BusinessObject could be found (e.g. the object was deleted).
  • access: public
Inx_Api_BusinessObject get (int $iIndex)
  • int $iIndex: the index of the Inx_Api_BusinessObject to retrieve in this result set.
remove (line 64)

Removes all business objects that are selected. have been removed.

Removes all business objects that are selected. The method returns true if and only if all selected elements have been removed. In some case it is possible that some elements cannot be removed (e.g. Inx_Api_List_SystemListContext, Properties, ... ).

  • return: true, if and only if the removing succeeded; false otherwise.
  • access: public
boolean remove (Inx_Api_IndexSelection $oSelection)
size (line 51)

Returns the number of business objects in this result set.

Returns the number of business objects in this result set.

  • return: the number of business objects.
  • access: public
int size ()

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