Skip navigation links

oracle.ocs.jcr.nodetype
Interface OracleNodeType

All Superinterfaces:

javax.jcr.nodetype.NodeType

public interface OracleNodeType

extends javax.jcr.nodetype.NodeType

Every node has a node type which defines the structure of the node. The node types are defined bottom up in our implementation i.e. for each content related entity that is supported in the beehive, a node type is defined. The following entities are supported:
Enterprise
Organization
Workspace
Heterogeneous Folder
Document.
Though Enterprise, organization and workspace are not really content related entities, they are required for accessing the content related entities by specifying the path. For each of the above entities, corresponding node type is defined. In addition to these, a base nodetype named beehive:base that extends from nt:node node type is also defined. This node type represents the properties of beehive entity. All the other nodetypes defined by the implementation extend from beehive:base nodetype.(i.e inherit the properties and children defined in the beehive:base nodetype).For other nodetypes, the important properties supported by the entities corresponding to them are included as properties in the nodetype definition. Use the appropriate string constants defined in this interface to specify the nodetypes.

Field Summary

static java.lang.String	BEEHIVE_BASE The base nodetype beehive:base that extends from nt:base nodetype, forms the supertype of all the nodetypes.
static java.lang.String	BEEHIVE_ENTERPRISE The Enterprise in Content Services is mapped to beehive:enterprise.
static java.lang.String	BEEHIVE_FILE The Document in Content Services is mapped to beehive:file.
static java.lang.String	BEEHIVE_FOLDER The Heterogeneous Folder in Content Services is mapped to beehive:folder.
static java.lang.String	BEEHIVE_FROZENNODE The nodetype jcr:frozenNode represents Frozen Node type.
static java.lang.String	BEEHIVE_LOCKABLE Only nodes with mixin node type mix:lockable may hold locks.
static java.lang.String	BEEHIVE_MIXREFERENCEABLE The nodetype mix:referenceable is required in order to support UUID-bearing nodes, which in turn support REFERENCE property types and versioning.
static java.lang.String	BEEHIVE_ORGANIZATION The Organization in Content Services is mapped to beehive:organization.
static java.lang.String	BEEHIVE_ROOT The Root Node is of type beehive:root.
static java.lang.String	BEEHIVE_ROOTVERSION The nodetype jcr:rootVersion represents root version.
static java.lang.String	BEEHIVE_TRASH The Trash in Content Services is mapped to beehive:trash.
static java.lang.String	BEEHIVE_TRASHITEM The Trash Item in Content Services is mapped to beehive:trashItem.
static java.lang.String	BEEHIVE_VERSION The nodetype nt:version represents a version.
static java.lang.String	BEEHIVE_VERSIONABLE Versioning requires the mixin node type mix:versionable.
static java.lang.String	BEEHIVE_VERSIONHISTORY The nodetype nt:versionHistory represents version history.
static java.lang.String	BEEHIVE_VERSIONLABEL The nodetype nt:versionLabels represents version Labels.
static java.lang.String	BEEHIVE_WORKSPACE The Workspace in Content Services is mapped to beehive:workspace.

Method Summary

boolean	canAddChildNode(java.lang.String childNodeName) Returns true if this node type allows the addition of a child node called childNodeName without specific node type information (that is, given the definition of this parent node type, the child node name is sufficient to determine the intended child node type).
boolean	canAddChildNode(java.lang.String childNodeName, java.lang.String nodeTypeName) Returns true if this node type allows the addition of a child node called childNodeName of node type nodeTypeName.
boolean	canRemoveItem(java.lang.String itemName) Returns true if removing the child item called itemName is allowed by this node type.
boolean	canSetProperty(java.lang.String propertyName, javax.jcr.Value value) Returns true if setting propertyName to value is allowed by this node type.
boolean	canSetProperty(java.lang.String propertyName, javax.jcr.Value[] values) Returns false since multiple values are not supported.
javax.jcr.nodetype.NodeDefinition[]	getChildNodeDefinitions() Returns an array containing the child node definitions of this node type, including the child node definitions inherited from supertypes of this node type.
javax.jcr.nodetype.NodeDefinition[]	getDeclaredChildNodeDefinitions() Returns an array containing the child node definitions explicitly specified in the declaration of this node type.
javax.jcr.nodetype.PropertyDefinition[]	getDeclaredPropertyDefinitions() Returns an array containing the property definitions explicitly specified in the declaration of this node type.
javax.jcr.nodetype.NodeType[]	getDeclaredSupertypes() Returns the direct supertypes of this node type in the node type inheritance hierarchy, that is, those actually declared in this node type.
java.lang.String	getName() Returns the name of the node type.
java.lang.String	getPrimaryItemName() Returns the name of the primary item (one of the child items of the nodes of this node type).
javax.jcr.nodetype.PropertyDefinition[]	getPropertyDefinitions() Returns an array containing the property definitions of this node type, including the property definitions inherited from supertypes of this node type.
javax.jcr.nodetype.NodeType[]	getSupertypes() Returns all supertypes of this node type in the node type inheritance hierarchy.
boolean	hasOrderableChildNodes() Returns false since ordering of nodes is not supported.
boolean	isMixin() Returns true if this node type is a mixin node type.
boolean	isNodeType(java.lang.String nodeTypeName) Returns true if this node type is nodeTypeName or a subtype of nodeTypeName, otherwise returns false.

Field Detail

BEEHIVE_ROOT

static final java.lang.String BEEHIVE_ROOT

The Root Node is of type beehive:root.

See Also:

Constant Field Values

BEEHIVE_ENTERPRISE

static final java.lang.String BEEHIVE_ENTERPRISE

The Enterprise in Content Services is mapped to beehive:enterprise.

See Also:

Constant Field Values

BEEHIVE_ORGANIZATION

static final java.lang.String BEEHIVE_ORGANIZATION

The Organization in Content Services is mapped to beehive:organization.

See Also:

Constant Field Values

BEEHIVE_WORKSPACE

static final java.lang.String BEEHIVE_WORKSPACE

The Workspace in Content Services is mapped to beehive:workspace.

See Also:

Constant Field Values

BEEHIVE_FOLDER

static final java.lang.String BEEHIVE_FOLDER

The Heterogeneous Folder in Content Services is mapped to beehive:folder.

See Also:

Constant Field Values

BEEHIVE_FILE

static final java.lang.String BEEHIVE_FILE

The Document in Content Services is mapped to beehive:file.

See Also:

Constant Field Values

BEEHIVE_TRASH

static final java.lang.String BEEHIVE_TRASH

The Trash in Content Services is mapped to beehive:trash.

See Also:

Constant Field Values

BEEHIVE_TRASHITEM

static final java.lang.String BEEHIVE_TRASHITEM

The Trash Item in Content Services is mapped to beehive:trashItem.

See Also:

Constant Field Values

BEEHIVE_BASE

static final java.lang.String BEEHIVE_BASE

The base nodetype beehive:base that extends from nt:base nodetype, forms the supertype of all the nodetypes.

See Also:

Constant Field Values

BEEHIVE_MIXREFERENCEABLE

static final java.lang.String BEEHIVE_MIXREFERENCEABLE

The nodetype mix:referenceable is required in order to support UUID-bearing nodes, which in turn support REFERENCE property types and versioning.

See Also:

Constant Field Values

BEEHIVE_LOCKABLE

static final java.lang.String BEEHIVE_LOCKABLE

Only nodes with mixin node type mix:lockable may hold locks.

See Also:

Constant Field Values

BEEHIVE_VERSIONABLE

static final java.lang.String BEEHIVE_VERSIONABLE

Versioning requires the mixin node type mix:versionable.

See Also:

Constant Field Values

BEEHIVE_VERSION

static final java.lang.String BEEHIVE_VERSION

The nodetype nt:version represents a version.

See Also:

Constant Field Values

BEEHIVE_VERSIONHISTORY

static final java.lang.String BEEHIVE_VERSIONHISTORY

The nodetype nt:versionHistory represents version history.

See Also:

Constant Field Values

BEEHIVE_VERSIONLABEL

static final java.lang.String BEEHIVE_VERSIONLABEL

The nodetype nt:versionLabels represents version Labels.

See Also:

Constant Field Values

BEEHIVE_FROZENNODE

static final java.lang.String BEEHIVE_FROZENNODE

The nodetype jcr:frozenNode represents Frozen Node type.

See Also:

Constant Field Values

BEEHIVE_ROOTVERSION

static final java.lang.String BEEHIVE_ROOTVERSION

The nodetype jcr:rootVersion represents root version.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns the name of the node type.

Specified by:

getName in interface javax.jcr.nodetype.NodeType

Returns:

the name of the node type

isMixin

boolean isMixin()

Returns true if this node type is a mixin node type. Returns false if this node type is a primary node type.

Specified by:

isMixin in interface javax.jcr.nodetype.NodeType

Returns:

a boolean

hasOrderableChildNodes

boolean hasOrderableChildNodes()

Returns false since ordering of nodes is not supported.

Specified by:

hasOrderableChildNodes in interface javax.jcr.nodetype.NodeType

Returns:

Returns false.

getPrimaryItemName

java.lang.String getPrimaryItemName()

Returns the name of the primary item (one of the child items of the nodes of this node type). If this node has no primary item, then this method returns null. This indicator is used by the method Node.getPrimaryItem().

Specified by:

getPrimaryItemName in interface javax.jcr.nodetype.NodeType

Returns:

the name of the primary item.

getSupertypes

javax.jcr.nodetype.NodeType[] getSupertypes()

Returns all supertypes of this node type in the node type inheritance hierarchy. For primary types apart from nt:base, this list will always include at least nt:base. For mixin types, there is no required supertype.

Specified by:

getSupertypes in interface javax.jcr.nodetype.NodeType

Returns:

an array of NodeType objects.

See Also:

getDeclaredSupertypes()

getDeclaredSupertypes

javax.jcr.nodetype.NodeType[] getDeclaredSupertypes()

Returns the direct supertypes of this node type in the node type inheritance hierarchy, that is, those actually declared in this node type.

Specified by:

getDeclaredSupertypes in interface javax.jcr.nodetype.NodeType

Returns:

an array of NodeType objects.

See Also:

getSupertypes()

isNodeType

boolean isNodeType(java.lang.String nodeTypeName)

Returns true if this node type is nodeTypeName or a subtype of nodeTypeName, otherwise returns false.

Specified by:

isNodeType in interface javax.jcr.nodetype.NodeType

Parameters:

nodeTypeName - the name of a node type.

Returns:

a boolean

getPropertyDefinitions

javax.jcr.nodetype.PropertyDefinition[] getPropertyDefinitions()

Returns an array containing the property definitions of this node type, including the property definitions inherited from supertypes of this node type.

Specified by:

getPropertyDefinitions in interface javax.jcr.nodetype.NodeType

Returns:

an array containing the property definitions.

See Also:

getDeclaredPropertyDefinitions()

getDeclaredPropertyDefinitions

javax.jcr.nodetype.PropertyDefinition[] getDeclaredPropertyDefinitions()

Returns an array containing the property definitions explicitly specified in the declaration of this node type. This does not include property definitions inherited from supertypes of this node type.

Specified by:

getDeclaredPropertyDefinitions in interface javax.jcr.nodetype.NodeType

Returns:

an array containing the property definitions.

See Also:

getPropertyDefinitions()

getChildNodeDefinitions

javax.jcr.nodetype.NodeDefinition[] getChildNodeDefinitions()

Returns an array containing the child node definitions of this node type, including the child node definitions inherited from supertypes of this node type.

Specified by:

getChildNodeDefinitions in interface javax.jcr.nodetype.NodeType

Returns:

an array containing the child node definitions.

See Also:

getDeclaredChildNodeDefinitions()

getDeclaredChildNodeDefinitions

javax.jcr.nodetype.NodeDefinition[] getDeclaredChildNodeDefinitions()

Returns an array containing the child node definitions explicitly specified in the declaration of this node type. This does not include child node definitions inherited from supertypes of this node type.

Specified by:

getDeclaredChildNodeDefinitions in interface javax.jcr.nodetype.NodeType

Returns:

an array containing the child node definitions.

See Also:

getChildNodeDefinitions()

canSetProperty

boolean canSetProperty(java.lang.String propertyName,
                       javax.jcr.Value value)

Returns true if setting propertyName to value is allowed by this node type. Otherwise returns false.

Specified by:

canSetProperty in interface javax.jcr.nodetype.NodeType

Parameters:

propertyName - The name of the property

value - A Value object.

canSetProperty

boolean canSetProperty(java.lang.String propertyName,
                       javax.jcr.Value[] values)

Returns false since multiple values are not supported.

Specified by:

canSetProperty in interface javax.jcr.nodetype.NodeType

Parameters:

propertyName - The name of the property

values - A Value array.

canAddChildNode

boolean canAddChildNode(java.lang.String childNodeName)

Returns true if this node type allows the addition of a child node called childNodeName without specific node type information (that is, given the definition of this parent node type, the child node name is sufficient to determine the intended child node type). Returns false otherwise.

Specified by:

canAddChildNode in interface javax.jcr.nodetype.NodeType

Parameters:

childNodeName - The name of the child node.

canAddChildNode

boolean canAddChildNode(java.lang.String childNodeName,
                        java.lang.String nodeTypeName)

Returns true if this node type allows the addition of a child node called childNodeName of node type nodeTypeName. Returns false otherwise.

Specified by:

canAddChildNode in interface javax.jcr.nodetype.NodeType

Parameters:

childNodeName - The name of the child node.

nodeTypeName - The name of the node type of the child node.

canRemoveItem

boolean canRemoveItem(java.lang.String itemName)

Returns true if removing the child item called itemName is allowed by this node type. Otherwise returns false.

Specified by:

canRemoveItem in interface javax.jcr.nodetype.NodeType

Parameters:

itemName - The name of the child item

Skip navigation links