Interface WebScheduleTrigger

    • Method Detail

      • getStartDate

        java.lang.String getStartDate()
        Returns the date after which this trigger will be active
        Returns:
        String containing mm/dd/yyyy formatted date
      • getNextDelivery

        @Deprecated
        java.lang.String getNextDelivery()
        Deprecated.
        Returns the next delivery of Time Based Trigger/Schedule in String format. The ZonedDateTime contains the date, time and server TimeZone in 'YYYY-MM-DDTHH:MM:SS.SSS X' format eg. '2011-12-03T10:15:30+01:00'.
        Returns:
        String
      • getNextDeliveryZonedDateTime

        java.time.ZonedDateTime getNextDeliveryZonedDateTime()
        Returns the next delivery of Time Based Trigger/Schedule in ZonedDateTime format. The ZonedDateTime contains the date, time and server TimeZone associated with Trigger/Schedule
        Returns:
        ZonedDateTime
        Since:
        MicroStrategy Web 11.3
      • setStartDate

        void setStartDate​(java.lang.String date)
        Sets the date after which this trigger will be active
        Parameters:
        date - String containing mm/dd/yy or mm/dd/yyyy formatted date. Empty or null string will result in no stop date for this trigger
      • getStopDate

        java.lang.String getStopDate()
        Returns the date after which this trigger will be inactive. Only meaningful if stop date is set. Use isStopDateSet() to verify that stop date is set
        Returns:
        String containing mm/dd/yyyy formatted date
      • isStopDateSet

        boolean isStopDateSet()
        Returns whether the stop date is set for this trigger
        Returns:
        boolean value stating whether the stop date is set for this trigger
      • setStopDate

        void setStopDate​(java.lang.String date)
        Sets the date after which this trigger will no longer fire.
        Parameters:
        date - String containing mm/dd/yy or mm/dd/yyyy formatted date. Empty or null string will result in no stop date for this trigger
      • setToDaily

        WebScheduleTriggerTimeDaily setToDaily()
        Return this trigger object as Daily Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger
        Returns:
        WebScheduleTriggerTimeDaily version of this trigger
      • setToWeekly

        WebScheduleTriggerTimeWeekly setToWeekly()
        Return this trigger object as Weekly Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger
        Returns:
        WebScheduleTriggerTimeWeekly version of this trigger
      • setToMonthly

        WebScheduleTriggerTimeMonthly setToMonthly()
        Return this trigger object as Monthly Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger
        Returns:
        WebScheduleTriggerTimeMonthly version of this trigger
      • setToYearly

        WebScheduleTriggerTimeYearly setToYearly()
        Return this trigger object as Yearly Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger
        Returns:
        WebScheduleTriggerTimeYearly version of this trigger
      • setToEvent

        WebScheduleTriggerEvent setToEvent()
        Return this trigger object as Event Trigger. All common values will remain the same; others will be reset to default values. Modifying the trigger returned by this method may cause interference with the values of this trigger
        Returns:
        WebScheduleTriggerEvent version of this trigger