org.alfresco.repo.virtual.store

Interface VirtualizationMethod

All Known Implementing Classes:

AspectVirtualizationMethod, CustomVirtualizationMethod, SystemVirtualizationMethod, TemplateVirtualizationMethod, TypeVirtualizationMethod

public interface VirtualizationMethod

Implementors define virtualization rules.
Virtualization is the process of converting NodeRefs into References in the context of given ActualEnvironment .

Author:

Bogdan Horje

Method Summary

Modifier and Type	Method and Description
boolean	canVirtualize(ActualEnvironment env, org.alfresco.service.cmr.repository.NodeRef nodeRef) Determines if a given NodeRef can be virtualized by this virtualization method.
Reference	virtualize(ActualEnvironment env, org.alfresco.service.cmr.repository.NodeRef nodeRef) Applies this virtualizatio rule on a given NodeRef.

Method Detail

canVirtualize

boolean canVirtualize(ActualEnvironment env,
                      org.alfresco.service.cmr.repository.NodeRef nodeRef)
               throws VirtualizationException

Determines if a given NodeRef can be virtualized by this virtualization method.

Parameters:

env - the environment in which the virtualization should take place

nodeRef - the NodeRef that should be virtualized

Returns:

true if the given NodeRef can be virtualized by this virtualization method
false otherwise

Throws:

VirtualizationException

virtualize

Reference virtualize(ActualEnvironment env,
                     org.alfresco.service.cmr.repository.NodeRef nodeRef)
              throws VirtualizationException

Applies this virtualizatio rule on a given NodeRef.

Parameters:

env - the environment in which the virtualization takes place

nodeRef - nodeRef the NodeRef that will be virtualized

Returns:

a Reference correspondent of the given NodeRef

Throws:

VirtualizationException