com.ibm.jarm.api.core

Interface AlternateRetentionList

    • Method Detail

      • get

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

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

        The removed AlternateRetention instance will be deleted from the repository when either the associated DispositionPhase.save method or the associated DispositionSchedule.save method is called.

        Parameters:
        index - the 1-based ordinal position to remove from.
        Throws:
        java.lang.IndexOutOfBoundsException - if index is out-of-range.
      • remove

        void remove(java.lang.String altRetentIdent)
        Removes the identified AlternateRetention instance from this collection.

        The removed AlternateRetention instance will be deleted from the repository when either the associated DispositionPhase.save method or the associated DispositionSchedule.save method is called.

        Parameters:
        altRetentIdent - the String alternate retention identifier. Cannot be null nor blank.
        Throws:
        API_ALTRETENT_NOT_IN_COLLECTION - if the specified AlternateRetention instance is not a member of this collection.
      • 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(AlternateRetention altRetent)
        Indicates whether or not the specified AlternateRetention instance is contained in this collection.
        Parameters:
        altRetent - the AlternateRetention instance to test for containment. Cannot be null.
        Returns:
        true if the specified altRetent is a member; false otherwise.
      • iterator

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

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