com.ibm.jarm.api.core

Interface DispositionTrigger

    • Method Detail

      • getTriggerName

        java.lang.String getTriggerName()
        Returns the DisposalTriggerName property value of this disposition trigger.
        Returns:
        A String value.
      • setTriggerName

        void setTriggerName(java.lang.String triggerName)
        Sets the DisposalTriggerName property value. This value must be unique amongst existing disposition triggers on a given file plan repository.

        Note that uniqueness validation does not occur until the save is called for disposition trigger instance.

        Parameters:
        triggerName - a String value. This entry cannot be null.
      • getDescription

        java.lang.String getDescription()
        Returns the RMEntityDescription property value of this disposition trigger.
        Returns:
        A String value. This entry can be null or empty.
      • setDescription

        void setDescription(java.lang.String value)
        Sets the RMEntityDescription property value for this disposition trigger.
        Parameters:
        value - a String value. This entry can be null or blank.
      • getAggregation

        java.lang.String getAggregation()
        Returns a string describing the entity-type level to which this disposition trigger applies.
        Returns:
        A String value.
      • setAggregation

        void setAggregation(java.lang.String aggregation)
        Defines the required entity-type level to which this disposition trigger applies. This value can only be set during the initial definition of a new disposition trigger (before the initial call to save is made). It can only accept values defined by the "Aggregation" choice list.
        Parameters:
        aggregation - A String value corresponding to a member value of the "Aggregation" choice list. This entry cannot be null.
      • getPropertyName

        java.lang.String getPropertyName()
        Returns the PropertyName property value of this disposition trigger.
        Returns:
        A String value. This entry can be null or empty.
      • setPropertyName

        void setPropertyName(java.lang.String propSymbolicName)
        Sets the value of the PropertyName property for this disposition trigger.
        Parameters:
        propSymbolicName - a String value. This entry can be null.
      • getPropertyValue

        java.lang.String getPropertyValue()
        Returns the value of the PropertyValue property for this disposition trigger.
        Returns:
        A String value. This entry can be null or empty.
      • setPropertyValue

        void setPropertyValue(java.lang.String value)
        Sets the value of the PropertyValue property for this disposition trigger.
        Parameters:
        value - a String value. This entry can be null.
      • getOperator

        java.lang.Integer getOperator()
        Returns the value of the Operator property for this disposition trigger.
        Returns:
        An Integer value. This entry can be null.
      • setOperator

        void setOperator(java.lang.Integer value)
        Sets the value of the Operator property for this disposition trigger.
        Parameters:
        value - an Integer value. This entry can be null.
      • getDateTime

        java.util.Date getDateTime()
        Returns a Date value for the disposition trigger's DateTime property, if any.
        Returns:
        A Date value. This entry can be null.
      • setDateTime

        void setDateTime(java.util.Date dateValue)
        Sets the value of the DateTime property for this disposition trigger.
        Parameters:
        dateValue - a Date value. This entry can be null.
      • getRecurringCyclePeriod

        java.lang.Integer[] getRecurringCyclePeriod()
        Returns the three Integer values that define the recurring cycle period in years, months and days, respectively, for a recurring trigger.
        Returns:
        returns an Integer[] of a fixed size of three entries. The first entry represents years. The second entry represents months. The third entry represents days.
      • setRecurringCyclePeriod

        void setRecurringCyclePeriod(java.lang.Integer years,
                                   java.lang.Integer months,
                                   java.lang.Integer days)
        Sets the recurring cycle period for a recurring trigger. At least one of the years, months or days input parameters must be a non-null value greater than 0.
        Parameters:
        years - an Integer value greater than or equal to 0. Can be null.
        months - an Integer value greater than or equal to 0. Can be null.
        days - an Integer value greater than or equal to 0. Can be null.
      • getExternalEventOccurrenceDate

        java.util.Date getExternalEventOccurrenceDate()
        Returns a Date value for the disposition trigger's ExternalEventOccurrenceDate property.
        Returns:
        A Date value. This entry can be null.
      • setExternalEventOccurrenceDate

        void setExternalEventOccurrenceDate(java.util.Date dateValue)
        Sets a Date value for the disposition trigger's ExternalEventOccurrenceDate property.
        Parameters:
        dateValue - a Date value. This entry can be null.
      • getConditionXML

        java.lang.String getConditionXML()
        Returns an XML string fragment describing the condition defined for this disposition trigger.
        Returns:
        A String XML fragment.
      • setConditionXML

        void setConditionXML(java.lang.String xmlFragment)
        Sets an XML string fragment that describes the condition defined for this disposition trigger.
        Parameters:
        xmlFragment - a String value. This entry can be null.
      • getAssociatedDispositionSchedules

        java.util.List<DispositionSchedule> getAssociatedDispositionSchedules()
        Returns a collection of DispositionSchedule instances where this DispositionTrigger is currently associated.
        Returns:
        A List of DispositionSchedule instances. This entry can be empty.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.