org.alfresco.module.org_alfresco_module_rm.vital

Interface VitalRecordService

All Known Implementing Classes:

VitalRecordServiceImpl

public interface VitalRecordService

Vital Record Service.

Since:

2.0

Author:

Roy Wetherall

Field Summary

Fields

Modifier and Type	Field and Description
static org.alfresco.service.cmr.repository.Period	PERIOD_NONE Period 'none'

Method Summary

Modifier and Type	Method and Description
VitalRecordDefinition	getVitalRecordDefinition(org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets the vital record definition details for the node.
boolean	isVitalRecord(org.alfresco.service.cmr.repository.NodeRef nodeRef) Indicates whether the record is a vital one or not.
void	setupVitalRecordDefinition(org.alfresco.service.cmr.repository.NodeRef nodeRef) Setup the vital record definition for the given node.
VitalRecordDefinition	setVitalRecordDefintion(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean enabled, org.alfresco.service.cmr.repository.Period reviewPeriod) Sets the vital record definition values for a given node.

Field Detail

PERIOD_NONE

static final org.alfresco.service.cmr.repository.Period PERIOD_NONE

Period 'none'

Method Detail

setupVitalRecordDefinition

void setupVitalRecordDefinition(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Setup the vital record definition for the given node.

Parameters:

nodeRef - node reference

getVitalRecordDefinition

VitalRecordDefinition getVitalRecordDefinition(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Gets the vital record definition details for the node.

Parameters:

nodeRef - node reference

Returns:

VitalRecordDefinition vital record definition details

setVitalRecordDefintion

VitalRecordDefinition setVitalRecordDefintion(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                              boolean enabled,
                                              org.alfresco.service.cmr.repository.Period reviewPeriod)

Sets the vital record definition values for a given node.

Parameters:

nodeRef -

enabled -

reviewPeriod -

Returns:

isVitalRecord

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

Indicates whether the record is a vital one or not.

Parameters:

nodeRef - node reference

Returns:

boolean true if this is a vital record, false otherwise