Package 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	Description
static final Period	PERIOD_NONE	Period 'none'

Method Summary

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

Field Details

PERIOD_NONE

static final Period PERIOD_NONE

Period 'none'

Method Details

setupVitalRecordDefinition

void setupVitalRecordDefinition(NodeRef nodeRef)

Setup the vital record definition for the given node.

Parameters:

nodeRef - node reference

getVitalRecordDefinition

VitalRecordDefinition getVitalRecordDefinition(NodeRef nodeRef)

Gets the vital record definition details for the node.

Parameters:

nodeRef - node reference

Returns:

VitalRecordDefinition vital record definition details

setVitalRecordDefintion

VitalRecordDefinition setVitalRecordDefintion(NodeRef nodeRef,
 boolean enabled,
 Period reviewPeriod)

Sets the vital record definition values for a given node.

Parameters:

nodeRef -

enabled -

reviewPeriod -

Returns:

isVitalRecord

boolean isVitalRecord(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