com.tsgrp.alfresco.behaviour

Class ControlledDocumentVersionPolicy

java.lang.Object

com.tsgrp.alfresco.chained.versionable.ChainedVersionLabelPolicy

com.tsgrp.alfresco.behaviour.ControlledDocumentVersionPolicy

All Implemented Interfaces:

org.alfresco.repo.policy.ClassPolicy, org.alfresco.repo.policy.Policy, org.alfresco.repo.version.VersionServicePolicies.BeforeCreateVersionPolicy, org.alfresco.repo.version.VersionServicePolicies.CalculateVersionLabelPolicy

Direct Known Subclasses:

TSGQualityDocumentBehaviors

public class ControlledDocumentVersionPolicy
extends com.tsgrp.alfresco.chained.versionable.ChainedVersionLabelPolicy
implements org.alfresco.repo.version.VersionServicePolicies.CalculateVersionLabelPolicy, org.alfresco.repo.version.VersionServicePolicies.BeforeCreateVersionPolicy

This class overrides the core Alfresco version policy, and implements behaviours that support this custom version policy(Starting at 0.1). It is extensible so that Controlled Document, Quality Document, and other may extend this class in order to gain access to the calculateVersionLabel method.

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.policy.Policy

org.alfresco.repo.policy.Policy.Arg

Field Summary

Fields

Modifier and Type	Field and Description
protected org.alfresco.repo.version.common.versionlabel.SerialVersionLabelPolicy	defaultPolicy
protected org.alfresco.service.namespace.NamespacePrefixResolver	prefixResolver
protected java.util.List<java.lang.String>	typeQNames

Fields inherited from class com.tsgrp.alfresco.chained.versionable.ChainedVersionLabelPolicy

isDeletedNode, oldNodeName, savedNodeRef, serviceRegistry

Fields inherited from interface org.alfresco.repo.version.VersionServicePolicies.BeforeCreateVersionPolicy

QNAME

Fields inherited from interface org.alfresco.repo.policy.Policy

NAMESPACE

Constructor Summary

Constructors

Constructor and Description
ControlledDocumentVersionPolicy()

Method Summary

Modifier and Type	Method and Description
void	beforeCreateVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef)
protected java.lang.String	calculateNextVersion(java.lang.String oldVersion, org.alfresco.service.cmr.version.VersionType majorOrMinor)
java.lang.String	calculateVersionLabel(org.alfresco.service.namespace.QName classRef, org.alfresco.service.cmr.version.Version preceedingVersion, int versionNumber, java.util.Map<java.lang.String,java.io.Serializable> versionProperties) Essentially do the same thing as Alfresco's standard CalculateVersionLabelPolicy, but ensure that documents start at 0.1 instead of 1.0 (minor vs major version type in Alfresco parlance)
org.alfresco.service.namespace.NamespacePrefixResolver	getNamespacePrefixResolver()
void	init()
void	setBehaviorFilter(org.alfresco.repo.policy.BehaviourFilter behaviorFilter)
void	setNamespacePrefixResolver(org.alfresco.service.namespace.NamespacePrefixResolver prefixResolver)
void	setPolicyComponent(org.alfresco.repo.policy.PolicyComponent policyComponent)
void	setSavedNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef) Deprecated. don't use this unless absolutely necessary
void	setServiceRegistry(org.alfresco.service.ServiceRegistry serviceRegistry)
void	setValidDoctypesForTSGVersionControl(java.util.List<java.lang.String> typeQNames)

Methods inherited from class com.tsgrp.alfresco.chained.versionable.ChainedVersionLabelPolicy

getVersionLabel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultPolicy

protected final org.alfresco.repo.version.common.versionlabel.SerialVersionLabelPolicy defaultPolicy

typeQNames

protected java.util.List<java.lang.String> typeQNames

prefixResolver

protected org.alfresco.service.namespace.NamespacePrefixResolver prefixResolver

Constructor Detail

ControlledDocumentVersionPolicy

public ControlledDocumentVersionPolicy()

Method Detail

setSavedNodeRef

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

Deprecated. don't use this unless absolutely necessary

This method was added to give OC methods like AlfrescoEmbContentImpl.addRelation(com.tsgrp.opencontent.core.content.model.AddRelationRequest) the ability to pass in a NodeRef to calculateVersionLabel(QName, Version, int, Map) when beforeCreateVersion(NodeRef) is never called. Note that this is only the case for non-Chain Versionable Legacy Controlled Document types, and will be removed once support for legacy types is no longer necessary. Do not call this without talking to George/Dan/Ben first!!!.

Parameters:

nodeRef -

setPolicyComponent

public void setPolicyComponent(org.alfresco.repo.policy.PolicyComponent policyComponent)

Overrides:

setPolicyComponent in class com.tsgrp.alfresco.chained.versionable.ChainedVersionLabelPolicy

setServiceRegistry

public void setServiceRegistry(org.alfresco.service.ServiceRegistry serviceRegistry)

Overrides:

setServiceRegistry in class com.tsgrp.alfresco.chained.versionable.ChainedVersionLabelPolicy

setValidDoctypesForTSGVersionControl

public void setValidDoctypesForTSGVersionControl(java.util.List<java.lang.String> typeQNames)

setNamespacePrefixResolver

public void setNamespacePrefixResolver(org.alfresco.service.namespace.NamespacePrefixResolver prefixResolver)

getNamespacePrefixResolver

public org.alfresco.service.namespace.NamespacePrefixResolver getNamespacePrefixResolver()

setBehaviorFilter

public void setBehaviorFilter(org.alfresco.repo.policy.BehaviourFilter behaviorFilter)

init

public void init()

Overrides:

init in class com.tsgrp.alfresco.chained.versionable.ChainedVersionLabelPolicy

beforeCreateVersion

public void beforeCreateVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Specified by:

beforeCreateVersion in interface org.alfresco.repo.version.VersionServicePolicies.BeforeCreateVersionPolicy

Overrides:

beforeCreateVersion in class com.tsgrp.alfresco.chained.versionable.ChainedVersionLabelPolicy

See Also:

VersionServicePolicies.BeforeCreateVersionPolicy.beforeCreateVersion(org.alfresco.service.cmr.repository.NodeRef)

calculateVersionLabel

public java.lang.String calculateVersionLabel(org.alfresco.service.namespace.QName classRef,
                                              org.alfresco.service.cmr.version.Version preceedingVersion,
                                              int versionNumber,
                                              java.util.Map<java.lang.String,java.io.Serializable> versionProperties)

Essentially do the same thing as Alfresco's standard CalculateVersionLabelPolicy, but ensure that documents start at 0.1 instead of 1.0 (minor vs major version type in Alfresco parlance)

Specified by:

calculateVersionLabel in interface org.alfresco.repo.version.VersionServicePolicies.CalculateVersionLabelPolicy

Overrides:

calculateVersionLabel in class com.tsgrp.alfresco.chained.versionable.ChainedVersionLabelPolicy

See Also:

VersionServicePolicies.CalculateVersionLabelPolicy.calculateVersionLabel(org.alfresco.service.namespace.QName, org.alfresco.service.cmr.version.Version, int, java.util.Map)

calculateNextVersion

protected java.lang.String calculateNextVersion(java.lang.String oldVersion,
                                                org.alfresco.service.cmr.version.VersionType majorOrMinor)