com.ibm.jarm.api.core

Interface DispositionPhase

  • All Superinterfaces:
    AuditableEntity, BaseEntity, Persistable, RMCustomObject


    public interface DispositionPhase
    extends RMCustomObject
    An interface that represents a "Phase" custom object that acts as a phase member of a DispositionSchedule.

    Disposition phase instances are created and managed using the DispositionSchedule and DispositionPhaseList interfaces.

    A new disposition phase is created using the DispositionSchedule instance to which it belongs, for example:

       // The disposition schedule to which a new phase is added.
       DispositionSchedule dispSched = ...;
       DispositionPhaseList dispPhases = dispSched.getDispositionPhases();
       DispositionPhase newPhase = dispSched.createNewPhase("Phase X");
       newPhase.setXXX(); ... // Further define the new phase instance.
       // Add the new phase to schedule's existing collection of phases.
       dispPhases.add(newPhase);
       // Finally save the schedule in order to persist the new phase to the repository.
       dispSched.save(RMRefreshMode.Refresh);
     

    Note the use of the DispositionSchedule.save method to persist the new disposition phase. The DispositionPhase.save method, on the other hand, is intended when persisting a change to an existing disposition phase.

    See Also:
    DispositionSchedule.getDispositionPhases, DispositionPhaseList
    • Method Detail

      • getPhaseName

        java.lang.String getPhaseName()
        Returns the PhaseName property value of this disposition phase.

        Note that the name of a dispostion phase is defined at the time it is created (i.e., DispositionSchedule.createNewPhase).

        Returns:
        A String value.
      • getDescription

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

        void setDescription(java.lang.String description)
        Sets the RMEntityDescription property value for this disposition phase.
        Parameters:
        description - a String value. Can be null or blank.
      • isScreeningRequired

        boolean isScreeningRequired()
        Returns true if screening is required for this disposition phase, false otherwise.
        Returns:
        true if screening is required; false otherwise.
      • setScreeningRequired

        void setScreeningRequired(boolean isRequired)
        Set the value for the "Is Screening Required" property.
        Parameters:
        isRequired - true if screening is required for this disposition phase; false otherwise.
      • getRetentionPeriod

        java.lang.Integer[] getRetentionPeriod()
        Returns the three Integer values that define the retention time period in years, months and days, respectively, for this disposition phase.
        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.
      • setRetentionPeriod

        void setRetentionPeriod(java.lang.Integer years,
                              java.lang.Integer months,
                              java.lang.Integer days)
        Sets the retention time period for this disposition phase.

        At least one of the years, months or days input parameters must be a non-null value greater than or equal to 0, unless this disposition phase currently has one or more alternate retention instances assigned to it. This requirement is validated at the time that the disposition phase or its parent disposition schedule is saved.

        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.
      • getReasonForChange

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

        void setReasonForChange(java.lang.String value)
        Sets the ReasonForChange property value for this disposition phase.
        Parameters:
        value - a String value. Can be null.
      • getExportDestination

        java.lang.String getExportDestination()
        Returns the ExportDestination property value of this disposition phase.
        Returns:
        A String value. This entry can be null.
      • setExportDestination

        void setExportDestination(java.lang.String fileSystemDirPath)
        Sets the ExportDestination property value for this disposition phase.
        Parameters:
        fileSystemDirPath - a file system directory path String. This entry can be null.
      • getExportFormat

        ContentItem getExportFormat()
        Returns the ExportFormate property value of this disposition phase.
        Returns:
        A ContentItem value. This entry can be null.
      • setExportFormat

        void setExportFormat(ContentItem contentItem)
        Sets the ExportFormat property value for this disposition phase.
        Parameters:
        contentItem - a ContentItem instance. This entry can be null.
      • getPhaseNumber

        java.lang.Integer getPhaseNumber()
        Returns the 1-based ordinal position of this disposition phase instance relative to its siblings that are also associated with its corresponding DispositionSchedule.
        Returns:
        An Integer value.
      • createAlternateRetention

        AlternateRetention createAlternateRetention(java.lang.String idStr)
        Creates a new AlternateRetention instance that can be further defined and then added to an AlternateRetentionList belonging to a specific DispositionPhase.
        Parameters:
        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 AlternateRetention instance.

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