Interface HoldService
-
- All Known Implementing Classes:
HoldServiceImpl
@AlfrescoPublicApi public interface HoldService
Hold service interface.- Since:
- 2.2
- Author:
- Tuna Aksoy
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addToHold(NodeRef hold, List<NodeRef> nodeRefs)
Adds the items to the the given holdvoid
addToHold(NodeRef hold, NodeRef nodeRef)
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 holdsNodeRef
createHold(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 holdList<NodeRef>
getHeld(NodeRef hold)
Gets the list of item node references which are in the given holdNodeRef
getHold(NodeRef filePlan, String name)
Gets the node reference for the hold with the given name in the given file planString
getHoldReason(NodeRef hold)
Gets the hold reason for the given hold node referenceList<NodeRef>
getHolds(NodeRef filePlan)
Gets the list of all the holds within the holds container in the given file planList<NodeRef>
heldBy(NodeRef nodeRef, boolean includedInHold)
Gets the list of all the holds within the holds container for the given node referenceboolean
isHold(NodeRef nodeRef)
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 Detail
-
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
- TheNodeRef
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
-
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
- 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
List<NodeRef> getHeld(NodeRef hold)
Gets the list of item node references 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
-
getHoldReason
String getHoldReason(NodeRef hold)
Gets the hold reason for the given hold node reference
-
deleteHold
void deleteHold(NodeRef hold)
Deletes the hold- Parameters:
hold
- TheNodeRef
of the hold
-
addToHold
void addToHold(NodeRef hold, List<NodeRef> nodeRefs)
Adds the items to the the given hold
-
addToHolds
void addToHolds(List<NodeRef> holds, NodeRef nodeRef)
Adds the item to the given list of 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 addednodeRefs
- 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
-
removeFromHold
void removeFromHold(NodeRef hold, List<NodeRef> nodeRefs)
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
void removeFromHolds(List<NodeRef> holds, NodeRef nodeRef)
Removes the item from the given list of hold
-
removeFromHolds
void removeFromHolds(List<NodeRef> holds, List<NodeRef> nodeRefs)
Removes the items from the given holds
-
removeFromAllHolds
void removeFromAllHolds(NodeRef nodeRef)
Removes the givenNodeRef
from all the holds- Parameters:
nodeRef
- TheNodeRef
of item which will be removed from all the holds
-
-