com.ibm.jarm.api.core

Interface Holdable

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.util.List<Hold> getAssociatedHolds()
      Gets the collection of holds that are directly associated with this object.
      java.util.List<RecordContainer> getParentsOnHold()
      Returns a collection of hierarchical parents of this object that are currently on hold.
      boolean isAnyChildOnHold()
      Indicates whether or not any hierarchical child RecordContainer or Record is currently on hold.
      boolean isAnyParentOnHold()
      Indicates whether or not any hierarchical parent container of this entity is currently on hold.
      boolean isOnHold(boolean checkParentContainerHierarchy)
      Indicates whether or not this entity is currently on hold.
      void placeHold(Hold hold)
      Place the specified Hold on this entity.
      void removeHold(Hold hold)
      Remove the specified Hold from this entity.
    • Method Detail

      • placeHold

        void placeHold(Hold hold)
        Place the specified Hold on this entity.
        Parameters:
        hold - - the Hold to place.
        Throws:
        RAL_UNABLE_TO_RETRIEVE_HOLD - if the specified hold is unavailable.
        API_CANNOT_APPLY_HOLD_THAT_IS_NOT_ACTIVE - if the specified hold is not active.
        API_CANNOT_ADD_HOLD_ALREADY_ASSOC_WITH_ENTITY - if the specified hold has already been placed on this entity.
      • removeHold

        void removeHold(Hold hold)
        Remove the specified Hold from this entity.
        Parameters:
        hold - - The Hold to remove.
        Throws:
        RAL_UNABLE_TO_RETRIEVE_HOLD - if the specified hold is unavailable.
        API_CANNOT_REMOVE_HOLD_NOT_ASSOC_WITH_OBJECT - if the specified hold is not placed on this entity.
        API_CANNOT_MANUALLY_REMOVE_DYNAMIC_HOLD - if the specified hold is a "dynamic" hold.
      • isOnHold

        boolean isOnHold(boolean checkParentContainerHierarchy)
        Indicates whether or not this entity is currently on hold.

        The checkParentContainerHierarchy parameter indicates whether the entity's parent hierarchy (up to the file plan level) should also be checked for any current hold.

        Parameters:
        checkParentContainerHierarchy - if true indicates that the entity's parent container hierarchy should also be examined for any currently placed holds.
        Returns:
        true if this entity is currently on hold or, assuming a true checkParentContainerHierarchy parameter value was specified, if any of this entity's hierarchical parents is currently on hold.
      • isAnyParentOnHold

        boolean isAnyParentOnHold()
        Indicates whether or not any hierarchical parent container of this entity is currently on hold.
        Returns:
        true if at least one hierarchical parent is currently on hold.
      • getAssociatedHolds

        java.util.List<Hold> getAssociatedHolds()
        Gets the collection of holds that are directly associated with this object.
        Returns:
        A List of Hold instances. This entry can be empty if no holds are applied to this entity.
      • getParentsOnHold

        java.util.List<RecordContainer> getParentsOnHold()
        Returns a collection of hierarchical parents of this object that are currently on hold.
        Returns:
        A List of RecordContainer instances. This entry can be empty if no parents are on hold.
      • isAnyChildOnHold

        boolean isAnyChildOnHold()
        Indicates whether or not any hierarchical child RecordContainer or Record is currently on hold.
        Returns:
        true if any hierarchical child is on hold.

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