org.apache.jackrabbit.core.version
Interface InternalFrozenNode

All Superinterfaces:
InternalFreeze, InternalVersionItem

public interface InternalFrozenNode
extends InternalFreeze

The InternalFrozenNode interface represents the frozen node that was generated during a Node.checkin(). It holds the set of frozen properties, the frozen child nodes and the frozen version history references of the original node.


Method Summary
 InternalFreeze getFrozenChildNode(Name name, int idx)
          Returns the frozen child node or null
 List<ChildNodeEntry> getFrozenChildNodes()
          Returns the list of frozen child nodes
 NodeId getFrozenId()
          Returns the frozen node id.
 Set<Name> getFrozenMixinTypes()
          Returns the list of names of the frozen mixin types.
 Name getFrozenPrimaryType()
          Returns the name of frozen primary type.
 PropertyState[] getFrozenProperties()
          Returns the list of frozen properties.
 boolean hasFrozenChildNode(Name name, int idx)
          Checks if this frozen node had the inidcated child node.
 
Methods inherited from interface org.apache.jackrabbit.core.version.InternalFreeze
getName
 
Methods inherited from interface org.apache.jackrabbit.core.version.InternalVersionItem
getId, getParent
 

Method Detail

getFrozenChildNodes

List<ChildNodeEntry> getFrozenChildNodes()
                                         throws VersionException
Returns the list of frozen child nodes

Returns:
an array of internal freezes
Throws:
VersionException - if the freezes cannot be retrieved

getFrozenProperties

PropertyState[] getFrozenProperties()
Returns the list of frozen properties.

Returns:
an array of property states

getFrozenId

NodeId getFrozenId()
Returns the frozen node id.

Returns:
the frozen id

getFrozenPrimaryType

Name getFrozenPrimaryType()
Returns the name of frozen primary type.

Returns:
the name of the frozen primary type.

getFrozenMixinTypes

Set<Name> getFrozenMixinTypes()
Returns the list of names of the frozen mixin types.

Returns:
the list of names of the frozen mixin types.

hasFrozenChildNode

boolean hasFrozenChildNode(Name name,
                           int idx)
Checks if this frozen node had the inidcated child node.

Parameters:
name - name of the childnode
idx - 1-based index
Returns:
true if the child node exists

getFrozenChildNode

InternalFreeze getFrozenChildNode(Name name,
                                  int idx)
                                  throws RepositoryException
Returns the frozen child node or null

Parameters:
name - name of the childnode
idx - 1-based index
Returns:
the child node
Throws:
RepositoryException - if an error occurs


Copyright © 2004-2010 The Apache Software Foundation. All Rights Reserved.