Package org.alfresco.module.org_alfresco_module_rm.hold

Interface HoldService

All Known Implementing Classes:
HoldServiceImpl
@AlfrescoPublicApi public interface HoldService
Hold service interface.
Since:
2.2
Author:
Tuna Aksoy

  • Method Details

    • isHold

      boolean isHold(NodeRef nodeRef)
      Indicates whether the passed node reference is a hold. A hold is a container for a group of frozen object and contains the freeze reason.
      Parameters:
      nodeRef - hold node reference
      Returns:
      boolean true if hold, false otherwise

    • getHolds

      List<NodeRef> getHolds(NodeRef filePlan)
      Gets the list of all the holds within the holds container in the given file plan
      Parameters:
      filePlan - The NodeRef of the file plan
      Returns:
      List of hold node references

    • getHold

      NodeRef getHold(NodeRef filePlan, String name)
      Gets the node reference for the hold with the given name in the given file plan
      Parameters:
      name - String The name of the hold
      Returns:
      NodeRef of the hold with the given name

    • heldBy

      List<NodeRef> heldBy(NodeRef nodeRef, boolean includedInHold)
      Gets the list of all the holds within the holds container for the given node reference
      Parameters:
      nodeRef - The NodeRef of the record / record folder /active content
      includedInHold - true to retrieve the list of hold node references which will include the node reference false to get a list of node references which will not have the given node reference
      Returns:
      List of hold node references

    • getHeld

      List<NodeRef> getHeld(NodeRef hold)
      Gets the list of item node references which are in the given hold
      Parameters:
      hold - NodeRef of the hold
      Returns:
      Lost of item NodeRefs which are in the given hold

    • createHold

      NodeRef createHold(NodeRef filePlan, String name, String reason, String description)
      Creates a hold with the given name, reason and description for the given file plan
      Parameters:
      filePlan - The NodeRef of the file plan
      name - String The name of the hold
      reason - String The reason of the hold
      description - String The description of the hold
      Returns:
      The NodeRef of the created hold

    • getHoldReason

      String getHoldReason(NodeRef hold)
      Gets the hold reason for the given hold node reference
      Parameters:
      hold - The NodeRef of the hold
      Returns:
      String The reason of the hold

    • setHoldReason

      void setHoldReason(NodeRef hold, String reason)
      Sets the hold reason
      Parameters:
      hold - The NodeRef of the hold
      reason - String The reason for the hold

    • deleteHold

      void deleteHold(NodeRef hold)
      Deletes the hold
      Parameters:
      hold - The NodeRef of the hold

    • addToHold

      void addToHold(NodeRef hold, NodeRef nodeRef)
      Adds the item to the given hold
      Parameters:
      hold - The NodeRef of the hold
      nodeRef - The NodeRef of the record / record folder / active content which will be added to the given hold

    • addToHold

      void addToHold(NodeRef hold, List<NodeRef> nodeRefs)
      Adds the items to the the given hold
      Parameters:
      hold - The NodeRef of the hold to which the items will be added
      nodeRefs - The item NodeRefs which will be added to the hold

    • addToHolds

      void addToHolds(List<NodeRef> holds, NodeRef nodeRef)
      Adds the item to the given list of holds
      Parameters:
      holds - The list of NodeRefs of the holds
      nodeRef - The NodeRef of the record / record folder / active content which will be added to the given holds

    • addToHolds

      void addToHolds(List<NodeRef> holds, List<NodeRef> nodeRefs)
      Adds the given items to the given list of holds
      Parameters:
      holds - List of holds to which the given items will be added
      nodeRefs - The list of items which will be added to the given holds

    • removeFromHold

      void removeFromHold(NodeRef hold, NodeRef nodeRef)
      Removes the record from the given hold
      Parameters:
      hold - The NodeRef of the hold
      nodeRef - The NodeRef of the record / record folder which will be removed from the given hold

    • removeFromHold

      void removeFromHold(NodeRef hold, List<NodeRef> nodeRefs)
      Removes the given items from the given hold
      Parameters:
      hold - The hold NodeRef from which the given items will be removed
      nodeRefs - The list of items which will be removed from the given holds

    • removeFromHolds

      void removeFromHolds(List<NodeRef> holds, NodeRef nodeRef)
      Removes the item from the given list of hold
      Parameters:
      holds - The list NodeRefs of the holds
      nodeRef - The NodeRef of the record / record folder which will be removed from the given holds

    • removeFromHolds

      void removeFromHolds(List<NodeRef> holds, List<NodeRef> nodeRefs)
      Removes the items from the given holds
      Parameters:
      holds - List of hold NodeRefs from which the items will be removed
      nodeRefs - List of item NodeRefs which will be removed from the given holds

    • removeFromAllHolds

      void removeFromAllHolds(NodeRef nodeRef)
      Removes the given NodeRef from all the holds
      Parameters:
      nodeRef - The NodeRef of item which will be removed from all the holds

    • removeFromAllHolds

      void removeFromAllHolds(List<NodeRef> nodeRefs)
      Removes the given list of NodeRefs from all the holds
      Parameters:
      nodeRefs - The list of item NodeRefs which will be removed from all the holds