com.ibm.jarm.api.core

Interface DispositionPhaseList

    • Method Detail

      • add

        int add(DispositionPhase phase)
        Adds the specified DispositionPhase instance to the end of this collection.

        Persistence of changes to this collection will not occur until the DispositionSchedule.save method is called on the corresponding DispositionSchedule.

        Parameters:
        phase - the DispositionPhase instance to add. Cannot be null.
        Returns:
        An integer value representing the 1-based ordinal position of the appended DispositionPhase instance within this collection.
        Throws:
        API_CANNOT_ADD_PHASE_ALREADY_EXISTS - if the phase already exists in this collection.
        API_CANNOT_ADD_PHASE_ALREADY_IN_USE - if the phase is already assigned to another schedule.
        API_CANNOT_ADD_PHASE_AFTER_TERMINATING_PHASE - if an attempt is made to add a new phase to a schedule that already contains a phase with an associated Destroy- or Transfer-type disposition action.
      • get

        DispositionPhase get(int position)
        Returns the DispositionPhase instance at the given 1-based ordinal position.
        Parameters:
        position - the 1-based ordinal position to retrieve from.
        Returns:
        A DispositionPhase instance.
        Throws:
        java.lang.IndexOutOfBoundsException - if position is out-of-range.
      • remove

        void remove(int position)
        Removes the DispositionPhase instance at the specified 1-based ordinal position.

        The removed DispositionPhase instance will be deleted from the repository when the DispositionSchedule.save method is called on the corresponding DispositionSchedule.

        Parameters:
        position - the 1-based ordinal position to remove from.
        Throws:
        java.lang.IndexOutOfBoundsException - if position is out-of-range.
        API_CANNOT_REMOVE_PHASE_IT_IS_IN_USE - if the DispositionPhase instance is currently in use by some Dispositionable object.
      • size

        int size()
        Returns the number of elements in this collection.
        Returns:
        the number of elements in this collection.
      • isEmpty

        boolean isEmpty()
        Indicates whether or not this collection is currently empty.
        Returns:
        true if the collection is empty; false otherwise.
      • contains

        boolean contains(DispositionPhase phase)
        Indicates whether or not the specified DispositionPhase instance is contained in this collection.
        Parameters:
        phase - the DispositionPhase instance to test for containment. Cannot be null.
        Returns:
        true if the specified DispositionPhase instance is a member; false otherwise.
      • iterator

        java.util.Iterator<DispositionPhase> iterator()
        Returns an iterator over the contents of this collection.
        Specified by:
        iterator in interface java.lang.Iterable<DispositionPhase>
        See Also:
        Iterable.iterator()

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