org.alfresco.module.org_alfresco_module_rm.freeze

Interface FreezeService

All Known Implementing Classes:

FreezeServiceImpl

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 Type	Method and Description
void	freeze(org.alfresco.service.cmr.repository.NodeRef hold, org.alfresco.service.cmr.repository.NodeRef nodeRef) Deprecated. as of 2.2, use HoldService.addToHold(NodeRef, NodeRef) instead.
void	freeze(org.alfresco.service.cmr.repository.NodeRef hold, Set<org.alfresco.service.cmr.repository.NodeRef> nodeRefs) Deprecated. as of 2.2, use HoldService#addToHold(NodeRef, List) instead.
org.alfresco.service.cmr.repository.NodeRef	freeze(String reason, org.alfresco.service.cmr.repository.NodeRef nodeRef) Deprecated. as of 2.2, use HoldService.createHold(NodeRef, String, String, String) and HoldService.addToHold(NodeRef, NodeRef) instead.
org.alfresco.service.cmr.repository.NodeRef	freeze(String reason, Set<org.alfresco.service.cmr.repository.NodeRef> nodeRefs) Deprecated. as of 2.2, use HoldService.createHold(NodeRef, String, String, String) and HoldService#addToHold(NodeRef, List) instead.
Date	getFreezeDate(org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets the date of the freeze for the given node, null if the node is not frozen
String	getFreezeInitiator(org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets the initiator of the freeze for the given node, null if the node is not frozen
Set<org.alfresco.service.cmr.repository.NodeRef>	getFrozen(org.alfresco.service.cmr.repository.NodeRef hold) Deprecated. as of 2.2, use HoldService.getHeld(NodeRef) instead.
Set<org.alfresco.service.cmr.repository.NodeRef>	getHolds(org.alfresco.service.cmr.repository.NodeRef filePlan) Deprecated. as of 2.2, use HoldService.getHolds(NodeRef) instead.
String	getReason(org.alfresco.service.cmr.repository.NodeRef hold) Deprecated. as of 2.2, use HoldService.getHoldReason(NodeRef) instead.
boolean	hasFrozenChildren(org.alfresco.service.cmr.repository.NodeRef nodeRef) Checks whether or not the given node has frozen children
boolean	isFrozen(org.alfresco.service.cmr.repository.NodeRef nodeRef) Indicates whether the passed node reference is frozen.
boolean	isHold(org.alfresco.service.cmr.repository.NodeRef nodeRef) Deprecated. as of 2.2, use HoldService.isHold(NodeRef) instead.
void	relinquish(org.alfresco.service.cmr.repository.NodeRef hold) Deprecated. as of 2.2, use HoldService.deleteHold(NodeRef) instead.
void	unFreeze(org.alfresco.service.cmr.repository.NodeRef nodeRef) Deprecated. as of 2.2, use HoldService.removeFromHold(NodeRef, NodeRef) instead.
void	unFreeze(Set<org.alfresco.service.cmr.repository.NodeRef> nodeRefs) Deprecated. as of 2.2, use HoldService.removeFromHolds(java.util.List, NodeRef) instead.
void	updateReason(org.alfresco.service.cmr.repository.NodeRef hold, String reason) Deprecated. as of 2.2, use HoldService.setHoldReason(NodeRef, String) instead.

Method Detail

isFrozen

boolean isFrozen(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Indicates whether the passed node reference is frozen.

Parameters:

nodeRef - node reference

Returns:

boolean true if frozen, false otherwise

hasFrozenChildren

boolean hasFrozenChildren(org.alfresco.service.cmr.repository.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(org.alfresco.service.cmr.repository.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(org.alfresco.service.cmr.repository.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(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Deprecated. as of 2.2, use HoldService.isHold(NodeRef) instead.

getFrozen

@Deprecated
Set<org.alfresco.service.cmr.repository.NodeRef> getFrozen(org.alfresco.service.cmr.repository.NodeRef hold)

Deprecated. as of 2.2, use HoldService.getHeld(NodeRef) instead.

freeze

@Deprecated
org.alfresco.service.cmr.repository.NodeRef freeze(String reason,
                                                               org.alfresco.service.cmr.repository.NodeRef nodeRef)

Deprecated. as of 2.2, use HoldService.createHold(NodeRef, String, String, String) and HoldService.addToHold(NodeRef, NodeRef) instead.

freeze

@Deprecated
void freeze(org.alfresco.service.cmr.repository.NodeRef hold,
                        org.alfresco.service.cmr.repository.NodeRef nodeRef)

Deprecated. as of 2.2, use HoldService.addToHold(NodeRef, NodeRef) instead.

freeze

@Deprecated
org.alfresco.service.cmr.repository.NodeRef freeze(String reason,
                                                               Set<org.alfresco.service.cmr.repository.NodeRef> nodeRefs)

Deprecated. as of 2.2, use HoldService.createHold(NodeRef, String, String, String) and HoldService#addToHold(NodeRef, List) instead.

freeze

@Deprecated
void freeze(org.alfresco.service.cmr.repository.NodeRef hold,
                        Set<org.alfresco.service.cmr.repository.NodeRef> nodeRefs)

Deprecated. as of 2.2, use HoldService#addToHold(NodeRef, List) instead.

unFreeze

@Deprecated
void unFreeze(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Deprecated. as of 2.2, use HoldService.removeFromHold(NodeRef, NodeRef) instead.

unFreeze

@Deprecated
void unFreeze(Set<org.alfresco.service.cmr.repository.NodeRef> nodeRefs)

Deprecated. as of 2.2, use HoldService.removeFromHolds(java.util.List, NodeRef) instead.

relinquish

@Deprecated
void relinquish(org.alfresco.service.cmr.repository.NodeRef hold)

Deprecated. as of 2.2, use HoldService.deleteHold(NodeRef) instead.

getReason

@Deprecated
String getReason(org.alfresco.service.cmr.repository.NodeRef hold)

Deprecated. as of 2.2, use HoldService.getHoldReason(NodeRef) instead.

updateReason

@Deprecated
void updateReason(org.alfresco.service.cmr.repository.NodeRef hold,
                              String reason)

Deprecated. as of 2.2, use HoldService.setHoldReason(NodeRef, String) instead.

getHolds

@Deprecated
Set<org.alfresco.service.cmr.repository.NodeRef> getHolds(org.alfresco.service.cmr.repository.NodeRef filePlan)

Deprecated. as of 2.2, use HoldService.getHolds(NodeRef) instead.