Interface Inx_Api_TriggerMailing_Descriptor_TriggerIntervalBuilder

Description

Inx_Api_TriggerMailing_Descriptor_TriggerIntervalBuilders are used to easily create Inx_Api_TriggerMailing_Descriptor_TriggerIntervals. settings and broken invariants. </i>Inx_Api_TriggerMailing_Descriptor_TriggerIntervalBuilderFactory</i>.

Inx_Api_TriggerMailing_Descriptor_TriggerIntervalBuilders are used to easily create Inx_Api_TriggerMailing_Descriptor_TriggerIntervals. They provide some guidance and will complain about any missing settings and broken invariants. The different builders are created using the </i>Inx_Api_TriggerMailing_Descriptor_TriggerIntervalBuilderFactory</i>.

Located in /Api/TriggerMailing/Descriptor/TriggerIntervalBuilder.php (line 17)


	
			
Direct descendents
Class Description
Inx_Api_TriggerMailing_Descriptor_DailyTriggerIntervalBuilder The Inx_Api_TriggerMailing_Descriptor_DailyTriggerIntervalBuilder is used to create a daily trigger interval.
Inx_Api_TriggerMailing_Descriptor_HourlyTriggerIntervalBuilder The Inx_Api_TriggerMailing_Descriptor_HourlyTriggerIntervalBuilder is used to create a hourly trigger interval.
Inx_Api_TriggerMailing_Descriptor_MonthlyTriggerIntervalBuilder The Inx_Api_TriggerMailing_Descriptor_MonthlyTriggerIntervalBuilder is used to create a monthly trigger interval.
Inx_Api_TriggerMailing_Descriptor_WeeklyTriggerIntervalBuilder The Inx_Api_TriggerMailing_Descriptor_WeeklyTriggerIntervalBuilder is used to create a weekly trigger interval.
Method Summary
Methods
build (line 32)

Creates the Inx_Api_TriggerMailing_Descriptor_TriggerInterval according to the settings. settings and broken invariants will trigger a certain kind of Exception like:

Creates the Inx_Api_TriggerMailing_Descriptor_TriggerInterval according to the settings. Any missing settings and broken invariants will trigger a certain kind of Exception like:

  • Inx_Api_NullPointerException: A mandatory setting was configured with null.
  • Inx_Api_IllegalArgumentException: A setting was configured with an illegal value.
  • Inx_Api_IllegalStateException: An invariant was broken or a mandatory setting is missing.

  • return: the icode>TriggerInterval</i> as defined by the settings.
  • throws: Exception if the settings are incorrect.
  • access: public
intervalCount (line 48)

Sets the interval count. example, when using a daily interval, the trigger is fired every X days where X is the interval count. setting is mandatory for all builders.

Sets the interval count. The interval count is used to specify how many times the trigger will be fired. For example, when using a daily interval, the trigger is fired every X days where X is the interval count. This setting is mandatory for all builders. The legal values for the interval count vary between the different interval types. They are defined by Inx_Api_TriggerMailing_Descriptor_TimeTriggerUnit::getMinValue() and Inx_Api_TriggerMailing_Descriptor_TimeTriggerUnit::getMaxValue().

  • return: the builder.
  • throws: Inx_Api_IllegalArgumentException if the interval count is out of legal bounds.
  • access: public
  • int $iCount: the interval count.

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