|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ExtendedNodeOps
This NodeOps interface was added so that if customers choose, they can implement it to get new functionality from the CM system.
Method Summary | |
---|---|
Node |
createNode(ID parentId,
String newNodeName,
int type,
ID workflowId)
This method creates a new Node underneath the parent. |
Node |
createNode(ID parentId,
String newNodeName,
int type,
ID objectClassId,
Property[] properties,
ID workflowId)
This method creates a new Node underneath the parent. |
Set<String> |
getNativeFilterableProperties(String repositoryName)
Returns a set of property names which the repository can filter natively (within the repository instead of the federated API) for paging purposes. |
Set<String> |
getNativeSortableProperties(String repositoryName)
Returns a set of property names which the repository can sort natively (within the repository instead of the federated API) for paging purposes. |
QueryResult<Node> |
getNodeChildren(ID parentId,
int type,
QueryCriteria queryCriteria)
This method returns all children Nodes for the parent Node ID. |
ID[] |
getNodeChildrenAsNodeIds(ID parentId,
int type)
This method returns an array of all children Node IDs for the parent Node. |
ID[] |
getNodeReferences(ID nodeId)
Retrieve nodes in this repository which have a link property referring to the specified node. |
QueryResult<Node> |
getNodes(ID[] nodeIds,
QueryCriteria queryCriteria,
boolean failSilently)
This method returns Nodes, one per node ID passed in. |
void |
orderBefore(ID parentNodeId,
ID srcChildNodeId,
ID destChildNodeId)
If the parent node type supports child node ordering, this method inserts the child node at srcChildNodeId before its sibling,
the child node at destChildNodeId . |
Node |
save(Node node)
This method updates an existing node in a single transaction. |
Methods inherited from interface com.bea.content.spi.NodeOps |
---|
addNodeContent, copyNode, createNode, createNode, deleteNode, getNode, getNode, getNodeChildren, getNodes, getProperties, getPropertyBytes, moveNode, removeNodeContent, renameNode, updateProperties |
Method Detail |
---|
Node save(Node node) throws AuthorizationException, RepositoryException
node
- The node to update with the various changes set accordingly.
AuthorizationException
- - if the user attempting the operation is not authorized to perform it.
RepositoryException
- - if validation error occurs.QueryResult<Node> getNodes(ID[] nodeIds, QueryCriteria queryCriteria, boolean failSilently) throws AuthorizationException, NoSuchNodeException
nodeIds
- - the Node IDs to retrieve the Nodes for.queryCriteria
- - the query criteria (possibly unsorted and unfiltered)failSilently
- - if true, then if a node cannot be found, no exception will be thrown
AuthorizationException
- - if the user attempting the
operation is not authorized to perform it.
NoSuchNodeException
- - if a node to get can't be found.QueryResult<Node> getNodeChildren(ID parentId, int type, QueryCriteria queryCriteria) throws AuthorizationException, NoSuchNodeException
parentId
- - the Node which may have childrentype
- - the type of children to return, either Node.HIERARCHY
, #CONTENT
or
Node.NODE
. If the type is Node.NODE
then all children (both
Node.HIERARCHY
and #CONTENT
will be returned. Use
of Node.HIERARCHY and Node.CONTENT will be deprecated in future releases.queryCriteria
- - the query Criteria (possibly unsorted and unfiltered)
AuthorizationException
- - if the user attempting the
operation is not authorized to perform it.
NoSuchNodeException
- - if the parent node can't be found.ID[] getNodeChildrenAsNodeIds(ID parentId, int type) throws AuthorizationException, NoSuchNodeException
parentId
- - the Node which may have childrentype
- - the type of children to return, either Node.HIERARCHY
, #CONTENT
or
Node.NODE
. If the type is Node.NODE
then all children (both
Node.HIERARCHY
and #CONTENT
will be returned. Use
of Node.HIERARCHY and Node.CONTENT will be deprecated in future releases.
AuthorizationException
- - if the user attempting the
operation is not authorized to perform it.
NoSuchNodeException
- - if the parent node can't be found.ID[] getNodeReferences(ID nodeId) throws AuthorizationException, RepositoryException
nodeId
- The ID
of the referred-to node.
AuthorizationException
- - if the user attempting the operation is not authorized to perform it
RepositoryException
Set<String> getNativeSortableProperties(String repositoryName) throws AuthorizationException, RepositoryException
repositoryName
- The name of the repository.
AuthorizationException
- - if the user attempting the operation is not authorized to perform it.
RepositoryException
- - if validation error occurs.Set<String> getNativeFilterableProperties(String repositoryName) throws AuthorizationException, RepositoryException
repositoryName
- The name of the repository.
AuthorizationException
- - if the user attempting the operation is not authorized to perform it.
RepositoryException
- - if validation error occurs.void orderBefore(ID parentNodeId, ID srcChildNodeId, ID destChildNodeId) throws ConstraintViolationException, NoSuchNodeException, AuthorizationException, RepositoryException
srcChildNodeId
before its sibling,
the child node at destChildNodeId
. Both nodes must be immediate children of
the parent node, parentNodeId
.
To place the node srcChildNodeId
at the end of the list, a destChildNodeId
of null
is used.
If srcChildNodeId
and destChildNodeId
are the same, then no change is made.
If this node does not support child node ordering, then a UnsupportedRepositoryOperationException
is thrown.
If srcChildNodeId
does not exist, then a NoSuchNodeException
is thrown.
If destChildNodeId
is neither null
nor a sibling of srcChildNodeId,
then a NoSuchNodeException
is also thrown.
If this operation would violate a node type or implementation-specific constraint,
a ConstraintViolationException
will be thrown.
parentNodeId
- the parent of both srcChildNodeId and destChildNodeId (possibly null for repo root)srcChildNodeId
- the child node to be moved in the orderingdestChildNodeId
- the child node before which the node srcChildId
will be placed, or null to
move the srcChildNode to the last position.
ConstraintViolationException
- if an implementation-specific constraint is violated
NoSuchNodeException
- if neither child node exists
RepositoryException
- if another error occurs
AuthorizationException
- if the user attempting the operation is not authorized to perform itNode createNode(ID parentId, String newNodeName, int type, ID objectClassId, Property[] properties, ID workflowId) throws AuthorizationException, NodeExistsException, NoSuchObjectClassException, RepositoryException
parentId
- - the id for the parent of the node. The parentId's uid is null
if the parent is root.newNodeName
- - the name of Node to create.type
- - the type of the node, either Node.HIERARCHY
or #CONTENT
. Use
of Node.HIERARCHY and Node.CONTENT will be deprecated in future releases.objectClassId
- - the ID for the ObjectClass to associate the new Node to.properties
- - the properties to add to the new Node.workflowId
- - the workflow to be associated with the node. If null, node uses the default workflow
AuthorizationException
- - if the user attempting the operation is not authorized to perform it
NodeExistsException
- - if the parent Node already has a child with the same name.
NoSuchObjectClassException
- - if the ObjectClass doesn't exist.
RepositoryException
- - if a validation error occurs.Node createNode(ID parentId, String newNodeName, int type, ID workflowId) throws AuthorizationException, NodeExistsException, RepositoryException
parentId
- - the id for the parent of the node. The uid is null if the parent is root.newNodeName
- - the name of Node to create.type
- - the type of the node, either Node.HIERARCHY
or #CONTENT
. Use
of Node.HIERARCHY and Node.CONTENT will be deprecated in future releases.workflowId
- - the workflow to be associated with the node. If null, node uses the default workflow
AuthorizationException
- - if the user attempting the operation is not authorized to perform it.
NodeExistsException
- - if the name for the node already exists as a child of the parent.
RepositoryException
- - if validation error occurs.
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |