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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description NodeRef
freeze(String reason, Set<NodeRef> nodeRefs)
Deprecated.as of 2.2, useHoldService.createHold(NodeRef, String, String, String)
andHoldService.addToHold(NodeRef, List)
instead.NodeRef
freeze(String reason, NodeRef nodeRef)
Deprecated.as of 2.2, useHoldService.createHold(NodeRef, String, String, String)
andHoldService.addToHold(NodeRef, NodeRef)
instead.void
freeze(NodeRef hold, Set<NodeRef> nodeRefs)
Deprecated.as of 2.2, useHoldService.addToHold(NodeRef, List)
instead.void
freeze(NodeRef hold, NodeRef nodeRef)
Deprecated.as of 2.2, useHoldService.addToHold(NodeRef, NodeRef)
instead.Date
getFreezeDate(NodeRef nodeRef)
Gets the date of the freeze for the given node, null if the node is not frozenString
getFreezeInitiator(NodeRef nodeRef)
Gets the initiator of the freeze for the given node, null if the node is not frozenSet<NodeRef>
getFrozen(NodeRef hold)
Deprecated.as of 2.2, useHoldService.getHeld(NodeRef)
instead.Set<NodeRef>
getHolds(NodeRef filePlan)
Deprecated.as of 2.2, useHoldService.getHolds(NodeRef)
instead.String
getReason(NodeRef hold)
Deprecated.as of 2.2, useHoldService.getHoldReason(NodeRef)
instead.boolean
hasFrozenChildren(NodeRef nodeRef)
Checks whether or not the given node has frozen childrenboolean
isFrozen(NodeRef nodeRef)
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
isHold(NodeRef nodeRef)
Deprecated.as of 2.2, useHoldService.isHold(NodeRef)
instead.void
relinquish(NodeRef hold)
Deprecated.as of 2.2, useHoldService.deleteHold(NodeRef)
instead.void
unFreeze(Set<NodeRef> nodeRefs)
Deprecated.as of 2.2, useHoldService.removeFromHolds(java.util.List, NodeRef)
instead.void
unFreeze(NodeRef nodeRef)
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 Detail
-
isFrozen
boolean isFrozen(NodeRef nodeRef)
Indicates whether the passed node reference is frozen.- Parameters:
nodeRef
- node reference- Returns:
- boolean true if frozen, false otherwise
-
hasFrozenChildren
boolean hasFrozenChildren(NodeRef nodeRef)
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
Date getFreezeDate(NodeRef nodeRef)
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
String getFreezeInitiator(NodeRef nodeRef)
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 boolean isHold(NodeRef nodeRef)
Deprecated.as of 2.2, useHoldService.isHold(NodeRef)
instead.
-
getFrozen
@Deprecated Set<NodeRef> getFrozen(NodeRef hold)
Deprecated.as of 2.2, useHoldService.getHeld(NodeRef)
instead.
-
freeze
@Deprecated NodeRef freeze(String reason, NodeRef nodeRef)
Deprecated.as of 2.2, useHoldService.createHold(NodeRef, String, String, String)
andHoldService.addToHold(NodeRef, NodeRef)
instead.
-
freeze
@Deprecated void freeze(NodeRef hold, NodeRef nodeRef)
Deprecated.as of 2.2, useHoldService.addToHold(NodeRef, NodeRef)
instead.
-
freeze
@Deprecated NodeRef freeze(String reason, Set<NodeRef> nodeRefs)
Deprecated.as of 2.2, useHoldService.createHold(NodeRef, String, String, String)
andHoldService.addToHold(NodeRef, List)
instead.
-
freeze
@Deprecated void freeze(NodeRef hold, Set<NodeRef> nodeRefs)
Deprecated.as of 2.2, useHoldService.addToHold(NodeRef, List)
instead.
-
unFreeze
@Deprecated void unFreeze(NodeRef nodeRef)
Deprecated.as of 2.2, useHoldService.removeFromHold(NodeRef, NodeRef)
instead.
-
unFreeze
@Deprecated void unFreeze(Set<NodeRef> nodeRefs)
Deprecated.as of 2.2, useHoldService.removeFromHolds(java.util.List, NodeRef)
instead.
-
relinquish
@Deprecated void relinquish(NodeRef hold)
Deprecated.as of 2.2, useHoldService.deleteHold(NodeRef)
instead.
-
getReason
@Deprecated String getReason(NodeRef hold)
Deprecated.as of 2.2, useHoldService.getHoldReason(NodeRef)
instead.
-
updateReason
@Deprecated void updateReason(NodeRef hold, String reason)
Deprecated.as of 2.2, useHoldService.setHoldReason(NodeRef, String)
instead.
-
getHolds
@Deprecated Set<NodeRef> getHolds(NodeRef filePlan)
Deprecated.as of 2.2, useHoldService.getHolds(NodeRef)
instead.
-
isFrozenOrHasFrozenChildren
boolean isFrozenOrHasFrozenChildren(NodeRef nodeRef)
Check given node or its children are frozen The node should be record or record folder for retention schedule- Parameters:
nodeRef
-
-
-