Interface Inx_Api_BOManager

Description

The Inx_Api_BOManager interface defines the basic requirements of a business object manager, including retrieval and removal of the managed objects.

The Inx_Api_BOManager interface defines the basic requirements of a business object manager, including retrieval and removal of the managed objects.

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

Located in /Api/BOManager.php (line 13)


	
			
Direct descendents
Class Description
Inx_Api_Action_ActionManager The Inx_Api_Action_ActionManager manages all actions.
Inx_Api_Approval_ApproverManager The Inx_Api_Approval_ApproverManager is used for the retrieval and creation of approvers.
Inx_Api_Blacklist_BlacklistManager Sometimes you might want to exclude particular e-mail addresses or whole address ranges from Inxmail.
Inx_Api_Bounce_BounceManager The Inx_Api_Bounce_BounceManager can be used to retrieve bounces.
Inx_Api_DesignTemplate_DesignCollectionManager The Inx_Api_DesignTemplate_DesignCollectionMananger can be used to access Inx_Api_DesignTemplate_DesignCollections.
Inx_Api_Filter_FilterManager Often, mailings are to be sent not to the whole recipient list but only to a certain subgroup of recipients.
Inx_Api_Inbox_InboxManager The Inx_Api_Inbox_InboxManager can be used to retrieve inbox messages.
Inx_Api_List_ListContextManager An Inx_Api_List_ListContext corresponds to a list in Inxmail, like a mailing list or the system list.
Inx_Api_Mailing_MailingManager The Inx_Api_Mailing_MailingManager manages all mailings.
Inx_Api_MailingTemplate_MailingTemplateManager The Inx_Api_MailingTemplate_MailingTemplateManager can be used to manage mailing templates.
Inx_Api_Resource_ResourceManager The Inx_Api_Resource_ResourceManager manages the file resources.
Inx_Api_SplitTest_SplitTestManager The SplitTestManager enables access to split tests. through the Inx_Api_SplitTestMailing_SplitTestMailing business object.
Inx_Api_SplitTestMailing_SplitTestMailingManager The SplitTestMailingManager enables access to split test mailings. through the Inx_Api_SplitTestMailing_SplitTestMailing business object.
Inx_Api_TextModule_TextModuleManager The Inx_Api_TextModule_TextModuleManager can be used to retrieve and create text modules.
Inx_Api_Transformation_TransformationManager The Inx_Api_Transformation_TransformationManager can be used to retrieve and create transformations.
Inx_Api_TriggerMailing_TriggerMailingManager The TriggerMailingManager manages all trigger mailings. used to perform the following tasks:
  • Retrieve mailings
  • Create mailings
  • Clone mailings
  • Create a renderer to generate a preview of the mailing
Be aware that this manager is not able to manage normal mailings. Inx_Api_Mailing_MailingManager.
Method Summary
boolean remove (int $iId)
Methods
get (line 23)

Returns the Inx_Api_BusinessObject with the specified id.

Returns the Inx_Api_BusinessObject with the specified id.

  • return: the Inx_Api_BusinessObject.
  • 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 $iId)
  • int $iId: the id of the Inx_Api_BusinessObject to retrieve.
remove (line 32)

Removes the Inx_Api_BusinessObject with the specified id.

Removes the Inx_Api_BusinessObject with the specified id.

  • return: true, if and only if the removing succeeded; false otherwise (e.g. the object was already deleted).
  • access: public
boolean remove (int $iId)
  • int $iId: the id of the Inx_Api_BusinessObject to be removed.
selectAll (line 43)

Returns an Inx_Api_BOResultSet containing all managed Inx_Api_BusinessObjects.

Returns an Inx_Api_BOResultSet containing all managed Inx_Api_BusinessObjects. For Inx_Api_Blacklist_BlacklistManager and Inx_Api_Resource_ResourceManager two params can be specified:

  1. int $iOrderAttribute the order attribute id.
  2. the order type (Inx_Api_Order::ASC or Inx_Api_Order::DESC).

  • return: an Inx_Api_BOResultSet containing all managed Inx_Api_BusinessObjects.
  • access: public
Inx_Api_BOResultSet selectAll ()

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