Interface Inx_Api_List_FilterListContext

Description

An Inx_Api_List_FilterListContext represents a mailing list with no permanent recipients.

An Inx_Api_List_FilterListContext represents a mailing list with no permanent recipients. The recipients of a filter list are computed based on a filter. All recipients that match that filter are recipients of the filter list. The recipients are computed each time a mailing is sent. For a detailed description of the filter statement syntax, see the documentation of Inx_Api_Filter_Filter->updateStatement(String);

  • version: $Revision: 9497 $ $Date: 2007-12-19 17:03:25 +0200 (Tr, 19 Grd 2007) $ $Author: aurimas $
  • see: Inx_Api_Filter_Filter::updateStatement(String)
  • since: API 1.0

Located in /Api/List/FilterListContext.php (line 21)

Inx_Api_BusinessObject
   |
   --Inx_Api_List_ListContext
      |
      --Inx_Api_List_FilterListContext
Class Constant Summary
Method Summary
string getFilterStmt ()
void updateFilterStmt (string $sFilterStmt)
void updateName (string $sName)
Methods
getFilterStmt (line 46)

Returns the filter statement.

Returns the filter statement.

  • return: the filter statement.
  • access: public
string getFilterStmt ()
updateFilterStmt (line 57)

Changes the filter statement.

Changes the filter statement. The list will not be updated on server until commitUpdate() has been called. For a detailed description of the filter statement syntax, see the documentation of Inx_Api_Filter_Filter->updateStatement(String)

  • see: Inx_Api_Filter_Filter::updateStatement(String)
  • access: public
void updateFilterStmt (string $sFilterStmt)
  • string $sFilterStmt: the new filter statement.
updateName (line 38)

Changes the list name.

Changes the list name. The list will not be updated on the server until commitUpdate() has been called.

  • access: public
void updateName (string $sName)
  • string $sName: the new list name.

Inherited Methods

Inherited From Inx_Api_List_ListContext

Inx_Api_List_ListContext::disableFeature()
Inx_Api_List_ListContext::enableFeature()
Inx_Api_List_ListContext::findProperty()
Inx_Api_List_ListContext::getCreationDatetime()
Inx_Api_List_ListContext::getDescription()
Inx_Api_List_ListContext::getListSize()
Inx_Api_List_ListContext::getName()
Inx_Api_List_ListContext::isFeatureEnabled()
Inx_Api_List_ListContext::selectProperties()
Inx_Api_List_ListContext::updateDescription()

Inherited From Inx_Api_BusinessObject

Inx_Api_BusinessObject::commitUpdate()
Inx_Api_BusinessObject::getId()
Inx_Api_BusinessObject::reload()
Class Constants
ATTRIBUTE_FILTER_STMT = 4 (line 29)

Constant for the filter statement attribute.

Constant for the filter statement attribute. Used by the Inx_Api_UpdateException to indicate the error source.

Inherited Constants

Inherited from Inx_Api_List_ListContext

Inx_Api_List_ListContext::ATTRIBUTE_DESCRIPTION
Inx_Api_List_ListContext::ATTRIBUTE_NAME

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