Interface HoldService
- All Known Implementing Classes:
HoldServiceImpl
@AlfrescoPublicApi
public interface HoldService
Hold service interface.
- Since:
- 2.2
- Author:
- Tuna Aksoy
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the items to the the given holdvoid
Adds the item to the given holdvoid
addToHolds
(List<NodeRef> holds, List<NodeRef> nodeRefs) Adds the given items to the given list of holdsvoid
addToHolds
(List<NodeRef> holds, NodeRef nodeRef) Adds the item to the given list of holdscreateHold
(NodeRef filePlan, String name, String reason, String description) Creates a hold with the given name, reason and description for the given file planvoid
deleteHold
(NodeRef hold) Deletes the holdGets the list of item node references which are in the given holdGets the node reference for the hold with the given name in the given file plangetHoldReason
(NodeRef hold) Gets the hold reason for the given hold node referenceGets the list of all the holds within the holds container in the given file planGets the list of all the holds within the holds container for the given node referenceboolean
Indicates whether the passed node reference is a hold.void
removeFromAllHolds
(List<NodeRef> nodeRefs) Removes the given list ofNodeRef
s from all the holdsvoid
removeFromAllHolds
(NodeRef nodeRef) Removes the givenNodeRef
from all the holdsvoid
removeFromHold
(NodeRef hold, List<NodeRef> nodeRefs) Removes the given items from the given holdvoid
removeFromHold
(NodeRef hold, NodeRef nodeRef) Removes the record from the given holdvoid
removeFromHolds
(List<NodeRef> holds, List<NodeRef> nodeRefs) Removes the items from the given holdsvoid
removeFromHolds
(List<NodeRef> holds, NodeRef nodeRef) Removes the item from the given list of holdvoid
setHoldReason
(NodeRef hold, String reason) Sets the hold reason
-
Method Details
-
isHold
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
Gets the list of all the holds within the holds container in the given file plan- Parameters:
filePlan
- TheNodeRef
of the file plan- Returns:
- List of hold node references
-
getHold
Gets the node reference for the hold with the given name in the given file plan -
heldBy
Gets the list of all the holds within the holds container for the given node reference- Parameters:
nodeRef
- TheNodeRef
of the record / record folder /active contentincludedInHold
-true
to retrieve the list of hold node references which will include the node referencefalse
to get a list of node references which will not have the given node reference- Returns:
- List of hold node references
-
getHeld
Gets the list of item node references which are in the given hold -
createHold
Creates a hold with the given name, reason and description for the given file plan -
getHoldReason
Gets the hold reason for the given hold node reference -
setHoldReason
Sets the hold reason -
deleteHold
Deletes the hold- Parameters:
hold
- TheNodeRef
of the hold
-
addToHold
Adds the item to the given hold -
addToHold
Adds the items to the the given hold -
addToHolds
Adds the item to the given list of holds -
addToHolds
Adds the given items to the given list of holds- Parameters:
holds
- List of holds to which the given items will be addednodeRefs
- The list of items which will be added to the given holds
-
removeFromHold
Removes the record from the given hold -
removeFromHold
Removes the given items from the given hold- Parameters:
hold
- The holdNodeRef
from which the given items will be removednodeRefs
- The list of items which will be removed from the given holds
-
removeFromHolds
Removes the item from the given list of hold -
removeFromHolds
Removes the items from the given holds -
removeFromAllHolds
Removes the givenNodeRef
from all the holds- Parameters:
nodeRef
- TheNodeRef
of item which will be removed from all the holds
-
removeFromAllHolds
Removes the given list ofNodeRef
s from all the holds- Parameters:
nodeRefs
- The list of itemNodeRef
s which will be removed from all the holds
-