org.alfresco.repo.avm

Interface AVMNode

All Known Subinterfaces:

DeletedNode, DirectoryNode, FileNode, Layered, LayeredDirectoryNode, LayeredFileNode, PlainDirectoryNode, PlainFileNode

All Known Implementing Classes:

AVMNodeImpl, DeletedNodeImpl, DirectoryNodeImpl, LayeredDirectoryNodeImpl, LayeredFileNodeImpl, PlainDirectoryNodeImpl, PlainFileNodeImpl

public interface AVMNode

The Interface for versionable objects.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAspect(org.alfresco.service.namespace.QName aspectQName)
void	addProperties(java.util.Map properties) Add properties to those that already exist.
void	changeAncestor(AVMNode ancestor) Change the ancestor of a node.
AVMNode	copy(org.alfresco.repo.avm.Lookup lPath) Possibly copy ourselves.
void	copyACLs(Acl otherAcl, Acl parentAcl, ACLCopyMode mode)
void	copyACLs(AVMNode other, ACLCopyMode mode) Copy ACL from another node.
void	copyMetaDataFrom(AVMNode other, java.lang.Long parentAcl) Copy metadata from another node.
void	deleteProperties() Delete all properties from this node.
void	deleteProperty(org.alfresco.service.namespace.QName qname) Delete a property from this node.
Acl	getAcl() Get the ACL on this node.
AVMNode	getAncestor() Get the ancestor of this node.
java.util.Set	getAspects() Get the Aspects that this node has.
BasicAttributes	getBasicAttributes() Get the Basic Attributes on this node.
AVMNodeDescriptor	getDescriptor(org.alfresco.repo.avm.Lookup lPath) Get the descriptor for this node.
AVMNodeDescriptor	getDescriptor(org.alfresco.repo.avm.Lookup lPath, java.lang.String name) Get the descriptor for this node.
AVMNodeDescriptor	getDescriptor(java.lang.String parentPath, java.lang.String name, java.lang.String parentIndirection, int parentIndirectionVersion) Get a node descriptor for this node.
java.lang.String	getGuid() Get the GUID associated with this version.
long	getId() Get the object id.
boolean	getIsNew() Get the newnews.
boolean	getIsRoot() Get whether this node is a root of a AVMStore.
AVMNode	getMergedFrom() Get the node this was merged from.
java.util.Map	getProperties() Get all the properties associated with this node.
PropertyValue	getProperty(org.alfresco.service.namespace.QName name) Get a property by name.
AVMStore	getStoreNew() Get the possibly null store that we're new in.
int	getType() Get the type of this node.
int	getVersionID() Get the version number.
void	removeAspect(org.alfresco.service.namespace.QName aspectQName)
void	setAcl(Acl acl) Set an ACL on this node.
void	setAncestor(AVMNode ancestor) Set the ancestor of this node.
void	setGuid(java.lang.String guid) Set the GUID associated with this version.
void	setIsRoot(boolean isRoot) Set whether this node to be a root of a AVMStore
void	setMergedFrom(AVMNode mergedFrom) Set the merged from node.
void	setProperties(java.util.Map properties) Set a collection of properties on this node.
void	setProperty(org.alfresco.service.namespace.QName qname, PropertyValue value) Set a property.
void	setStoreNew(AVMStore store) Set the store that we are new in.
void	setVersionID(int version) Set the version number.
java.lang.String	toString(org.alfresco.repo.avm.Lookup lPath) Get a string representation for debugging.
void	updateModTime() Update the modification time of this node.

Method Detail

setAncestor

void setAncestor(AVMNode ancestor)

Set the ancestor of this node.

Parameters:

ancestor - The ancestor to set.

changeAncestor

void changeAncestor(AVMNode ancestor)

Change the ancestor of a node.

Parameters:

ancestor - The ancestor node that should be set.

getAncestor

AVMNode getAncestor()

Get the ancestor of this node.

Returns:

The ancestor of this node.

setMergedFrom

void setMergedFrom(AVMNode mergedFrom)

Set the merged from node.

Parameters:

mergedFrom - The merged from node.

getMergedFrom

AVMNode getMergedFrom()

Get the node this was merged from.

Returns:

The node this was merged from.

getVersionID

int getVersionID()

Get the version number.

Returns:

The version number.

setVersionID

void setVersionID(int version)

Set the version number.

Parameters:

version - The version number to set.

copy

AVMNode copy(org.alfresco.repo.avm.Lookup lPath)

Possibly copy ourselves.

Parameters:

lPath - The Lookup for this node.

Returns:

A copy of ourself or null if no copy was necessary.

getType

int getType()

Get the type of this node.

getDescriptor

AVMNodeDescriptor getDescriptor(org.alfresco.repo.avm.Lookup lPath,
                              java.lang.String name)

Get the descriptor for this node.

Parameters:

lPath - The Lookup.

name - The name of this in the current context.

Returns:

The descriptor for this node.

getDescriptor

AVMNodeDescriptor getDescriptor(org.alfresco.repo.avm.Lookup lPath)

Get the descriptor for this node.

Parameters:

lPath - The Lookup.

Returns:

The descriptor for this node.

getDescriptor

AVMNodeDescriptor getDescriptor(java.lang.String parentPath,
                              java.lang.String name,
                              java.lang.String parentIndirection,
                              int parentIndirectionVersion)

Get a node descriptor for this node.

Parameters:

parentPath - The parent path.

name - The name looked up as.

parentIndirection - The indirection of the parent.

parentIndirectionVersion - The indirection version of the parent.

Returns:

The descriptor for this node.

getId

long getId()

Get the object id.

Returns:

The object id.

getIsNew

boolean getIsNew()

Get the newnews.

Returns:

Whether the node is new.

toString

java.lang.String toString(org.alfresco.repo.avm.Lookup lPath)

Get a string representation for debugging.

Parameters:

lPath - The Lookup.

Returns:

A String representation.

setIsRoot

void setIsRoot(boolean isRoot)

Set whether this node to be a root of a AVMStore

Parameters:

isRoot -

getIsRoot

boolean getIsRoot()

Get whether this node is a root of a AVMStore.

Returns:

Whether this node is a root.

updateModTime

void updateModTime()

Update the modification time of this node.

setProperty

void setProperty(org.alfresco.service.namespace.QName qname,
               PropertyValue value)

Set a property.

Parameters:

qname - the QName

value - The value to set.

setProperties

void setProperties(java.util.Map properties)

Set a collection of properties on this node.

Parameters:

properties - The Map of QNames to PropertyValues.

addProperties

void addProperties(java.util.Map properties)

Add properties to those that already exist.

Parameters:

properties - The properties to add.

getProperty

PropertyValue getProperty(org.alfresco.service.namespace.QName name)

Get a property by name.

Parameters:

name - The name of the property to get.

Returns:

A PropertyValue

getProperties

java.util.Map getProperties()

Get all the properties associated with this node.

Returns:

A Map of QNames to PropertyValues.

deleteProperty

void deleteProperty(org.alfresco.service.namespace.QName qname)

Delete a property from this node.

Parameters:

qnameEntityId - the ID of the QName to delete

deleteProperties

void deleteProperties()

Delete all properties from this node.

setAcl

void setAcl(Acl acl)

Set an ACL on this node.

Parameters:

acl - The ACL to set.

getAcl

Acl getAcl()

Get the ACL on this node.

Returns:

The ACL on this node.

setStoreNew

void setStoreNew(AVMStore store)

Set the store that we are new in.

Parameters:

store - The store we are new in.

getStoreNew

AVMStore getStoreNew()

Get the possibly null store that we're new in.

Returns:

The store that we're new in.

copyACLs

void copyACLs(AVMNode other,
            ACLCopyMode mode)

Copy ACL from another node.

Parameters:

other -

mode -

copyACLs

void copyACLs(Acl otherAcl,
            Acl parentAcl,
            ACLCopyMode mode)

copyMetaDataFrom

void copyMetaDataFrom(AVMNode other,
                    java.lang.Long parentAcl)

Copy metadata from another node.

Parameters:

other - The other node.

getGuid

java.lang.String getGuid()

Get the GUID associated with this version.

Returns:

The GUID.

setGuid

void setGuid(java.lang.String guid)

Set the GUID associated with this version.

Parameters:

guid -

getAspects

java.util.Set getAspects()

Get the Aspects that this node has.

Returns:

A Set of Aspects IDs.

addAspect

void addAspect(org.alfresco.service.namespace.QName aspectQName)

removeAspect

void removeAspect(org.alfresco.service.namespace.QName aspectQName)

getBasicAttributes

BasicAttributes getBasicAttributes()

Get the Basic Attributes on this node.

Returns: