Interface FreezeService
- All Known Implementing Classes:
FreezeServiceImpl
@AlfrescoPublicApi
public interface FreezeService
Freeze Service Interface
TODO should be deprecated and methods moved to the HoldService with "hold, held, etc" style names
- Since:
- 2.0
- Author:
- Roy Wetherall
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Deprecated.as of 2.2, useHoldService.createHold(NodeRef, String, String, String)
andHoldService.addToHold(NodeRef, NodeRef)
instead.void
Deprecated.as of 2.2, useHoldService.addToHold(NodeRef, List)
instead.void
Deprecated.as of 2.2, useHoldService.addToHold(NodeRef, NodeRef)
instead.getFreezeDate
(NodeRef nodeRef) Gets the date of the freeze for the given node, null if the node is not frozengetFreezeInitiator
(NodeRef nodeRef) Gets the initiator of the freeze for the given node, null if the node is not frozenDeprecated.as of 2.2, useHoldService.getHeld(NodeRef)
instead.Deprecated.as of 2.2, useHoldService.getHolds(NodeRef)
instead.Deprecated.as of 2.2, useHoldService.getHoldReason(NodeRef)
instead.boolean
hasFrozenChildren
(NodeRef nodeRef) Checks whether or not the given node has frozen childrenboolean
Indicates whether the passed node reference is frozen.boolean
isFrozenOrHasFrozenChildren
(NodeRef nodeRef) Check given node or its children are frozen The node should be record or record folder for retention scheduleboolean
Deprecated.as of 2.2, useHoldService.isHold(NodeRef)
instead.void
relinquish
(NodeRef hold) Deprecated.as of 2.2, useHoldService.deleteHold(NodeRef)
instead.void
Deprecated.as of 2.2, useHoldService.removeFromHolds(java.util.List, NodeRef)
instead.void
Deprecated.as of 2.2, useHoldService.removeFromHold(NodeRef, NodeRef)
instead.void
updateReason
(NodeRef hold, String reason) Deprecated.as of 2.2, useHoldService.setHoldReason(NodeRef, String)
instead.
-
Method Details
-
isFrozen
Indicates whether the passed node reference is frozen.- Parameters:
nodeRef
- node reference- Returns:
- boolean true if frozen, false otherwise
-
hasFrozenChildren
Checks whether or not the given node has frozen children- Parameters:
nodeRef
- The nodeRef for which will be checked if it has frozen children- Returns:
- true if the given nodeRef has frozen children, false otherwise
-
getFreezeDate
Gets the date of the freeze for the given node, null if the node is not frozen- Parameters:
nodeRef
- The nodeRef for which the date check will be performed- Returns:
- Date The of the freeze or null
-
getFreezeInitiator
Gets the initiator of the freeze for the given node, null if the node is not frozen- Parameters:
nodeRef
- The nodeRef for which the initiator check will be performed- Returns:
- String The initiator of the freeze or null
-
isHold
Deprecated.as of 2.2, useHoldService.isHold(NodeRef)
instead. -
getFrozen
Deprecated.as of 2.2, useHoldService.getHeld(NodeRef)
instead. -
freeze
Deprecated.as of 2.2, useHoldService.createHold(NodeRef, String, String, String)
andHoldService.addToHold(NodeRef, NodeRef)
instead. -
freeze
Deprecated.as of 2.2, useHoldService.addToHold(NodeRef, NodeRef)
instead. -
freeze
Deprecated.as of 2.2, useHoldService.createHold(NodeRef, String, String, String)
andHoldService.addToHold(NodeRef, List)
instead. -
freeze
Deprecated.as of 2.2, useHoldService.addToHold(NodeRef, List)
instead. -
unFreeze
Deprecated.as of 2.2, useHoldService.removeFromHold(NodeRef, NodeRef)
instead. -
unFreeze
Deprecated.as of 2.2, useHoldService.removeFromHolds(java.util.List, NodeRef)
instead. -
relinquish
Deprecated.as of 2.2, useHoldService.deleteHold(NodeRef)
instead. -
getReason
Deprecated.as of 2.2, useHoldService.getHoldReason(NodeRef)
instead. -
updateReason
Deprecated.as of 2.2, useHoldService.setHoldReason(NodeRef, String)
instead. -
getHolds
Deprecated.as of 2.2, useHoldService.getHolds(NodeRef)
instead. -
isFrozenOrHasFrozenChildren
Check given node or its children are frozen The node should be record or record folder for retention schedule- Parameters:
nodeRef
-
-
HoldService.createHold(NodeRef, String, String, String)
andHoldService.addToHold(NodeRef, List)
instead.