com.ibm.jarm.api.core

Interface DispositionSchedule

    • Method Detail

      • getScheduleName

        java.lang.String getScheduleName()
        Returns the DisposalScheduleName property value of this disposition schedule.
        Returns:
        A String value.
      • setScheduleName

        void setScheduleName(java.lang.String name)
        Sets the DisposalScheduleName property value for this disposition schedule.

        This name value must be unique relative to all other disposition schedules defined on the same file plan repository. Validation of such name uniqueness does not occur until the save is called.

        Parameters:
        name - a String value. This entry cannot be null nor blank.
      • getDescription

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

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

        java.util.Date getCalendarDate()
        Returns the CalendarDate property value of this disposition schedule.
        Returns:
        a Date value. This entry can be null.
      • setCalendarDate

        void setCalendarDate(java.util.Date dateValue)
        Sets the CalendarDate property value for this disposition schedule.
        Parameters:
        dateValue - a Date value. This entry can be null.
      • getCutoffBase

        java.lang.String getCutoffBase()
        Returns the symbolic name of the Date-type property that defines the cutoff base for this DispositionSchedule.
        Returns:
        A String defining the property's symbolic name.
      • setCutoffBase

        void setCutoffBase(java.lang.String propertySymbolicName)
        Sets the symbolic name of the property to be used as the cutoff base value.
        Parameters:
        propertySymbolicName - the property symbolic name String.
      • getDispositionAuthority

        java.lang.String getDispositionAuthority()
        Returns the AuthorizingStatute property value of this disposition schedule.
        Returns:
        A String value. This entry can be null.
      • setDispositionAuthority

        void setDispositionAuthority(java.lang.String value)
        Sets the AuthorizingStatute property value for this disposition schedule.
        Parameters:
        value - a String value. This entry can be null or blank.
      • getDispositionEventOffset

        java.lang.Integer[] getDispositionEventOffset()
        Returns the three Integer values that define the cutoff event offset time period in years, months and days, respectively.
        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. Any of these values can be null or an Integer value greater than or equal to 0.
      • setDispositionEventOffset

        void setDispositionEventOffset(java.lang.Integer years,
                                     java.lang.Integer months,
                                     java.lang.Integer days)
        Sets the cutoff event offset time period for this disposition schedule.
        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.
      • setDispositionTigger

        void setDispositionTigger(DispositionTrigger trigger)
        Sets the CutoffDisposalTrigger property value for this DispositionSchedule instance.
        Parameters:
        trigger - a DispositionTrigger instance. This entry cannot be null.
      • createNewPhase

        DispositionPhase createNewPhase(java.lang.String phaseName,
                                      java.lang.String idStr)
        Creates a new DispositionPhase instance that can be further defined and then added to a DispositionPhaseList.
        Parameters:
        phaseName - String name to assign to the new phase. This entry cannot be null or blank.
        idStr - a String Id value to be assigned to the new instance. This parameter can be null in which case an Id value will be automatically generated for the new instance.
        Returns:
        A new DispositionPhase instance.
      • getAssociatedRecordCategories

        java.util.List<RecordCategory> getAssociatedRecordCategories()
        Returns a collection of RecordCategory instances to which this DispositionSchedule instance is directly associated.
        Returns:
        A List of RecordCategory instances.
      • getAssociatedRecordFolders

        java.util.List<RecordFolder> getAssociatedRecordFolders()
        Returns a collection of RecordFolder instances to which this DispositionSchedule instance is directly associated.
        Returns:
        A List of RecordFolder instances.
      • getAssociatedRecordTypes

        java.util.List<RecordType> getAssociatedRecordTypes()
        Returns a collection of RecordType instances to which this DispositionSchedule instance is directly associated.
        Returns:
        A List of RecordType instances.
      • getEffectiveDateModified

        java.util.Date getEffectiveDateModified()
        Returns the EffectiveDateModified property value of this disposition schedule.
        Returns:
        A Date value. This entry can be null.
      • isScreeningRequired

        java.lang.Boolean isScreeningRequired()
        Returns the IsScreeningRequired property value of this disposition schedule.
        Returns:
        A Boolean value. This entry can be null.
      • setScreeningRequired

        void setScreeningRequired(java.lang.Boolean value)
        Sets the IsScreeningRequired property value for this disposition schedule.
        Parameters:
        value - a Boolean value. This entry can be null.
      • isTriggerChanged

        java.lang.Boolean isTriggerChanged()
        Returns the IsTriggerChanged property value of this disposition schedule.
        Returns:
        A Boolean value. This entry can be null.
      • getReasonForChange

        java.lang.String getReasonForChange()
        Returns the ReasonForChange property value of this disposition schedule.
        Returns:
        A String value. This entry can be null.
      • setReasonForChange

        void setReasonForChange(java.lang.String reason)
        Assigns a value to the ReasonForChange property. A non-null, non-blank ReasonForChange value is required when performing any update to an existing schedule.
        Parameters:
        reason - A String value. This entry should not be null or blank when an update is being performed.
      • getAuditXML

        java.lang.String getAuditXML()
        Returns the SweepAuditXML property value of this disposition schedule.
        Returns:
        A String value. This entry can be null.
      • getSweepState

        java.lang.Integer getSweepState()
        Returns the SweepState property value of this disposition schedule.
        Returns:
        An Integer value. This entry can be null.
      • recalculateCutoffDate

        void recalculateCutoffDate(Dispositionable entity)
        Recalculates the cutoff date for the given entity based upon this disposition schedule.
        Parameters:
        entity - the Dispositionable entity to perform update calculation for.
        Throws:
        API_ENTITY_MISSING_CUTOFF_BASE_DATE - if the applicable cutoff base date is null.
        API_DISPOSITION_TRIGGER_INVALID_TRIGGER_TYPE - if cutoff disposition trigger is an invalid trigger type.

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