Moving to root below branch label

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2005 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/repo/node/db/NodeDaoService.java

@@ -0,0 +1,179 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.repo.node.db;
+
+import java.util.Collection;
+import java.util.List;
+
+import org.alfresco.repo.domain.ChildAssoc;
+import org.alfresco.repo.domain.Node;
+import org.alfresco.repo.domain.NodeAssoc;
+import org.alfresco.repo.domain.NodeStatus;
+import org.alfresco.repo.domain.Store;
+import org.alfresco.service.cmr.dictionary.InvalidTypeException;
+import org.alfresco.service.namespace.QName;
+
+/**
+ * Service layer accessing persistent <b>node</b> entities directly
+ * 
+ * @author Derek Hulley
+ */
+public interface NodeDaoService
+{
+    /**
+     * Are there any pending changes which must be synchronized with the store?
+     * 
+     * @return true => changes are pending
+     */
+    public boolean isDirty();
+    
+    /**
+     * Fetch a list of all stores in the repository
+     * 
+     * @return Returns a list of stores
+     */
+    public List<Store> getStores();
+    
+    /**
+     * Creates a unique store for the given protocol and identifier combination
+     * 
+     * @param protocol a protocol, e.g. {@link org.alfresco.service.cmr.repository.StoreRef#PROTOCOL_WORKSPACE}
+     * @param identifier a protocol-specific identifier
+     * @return Returns the new persistent entity
+     */
+    public Store createStore(String protocol, String identifier);
+    
+    /**
+     * @param protocol the protocol that the store serves
+     * @param identifier the protocol-specific identifer
+     * @return Returns a store with the given values or null if one doesn't exist
+     */
+    public Store getStore(String protocol, String identifier);
+
+    /**
+     * @param store the store to which the node must belong
+     * @param id the node store-unique identifier
+     * @param nodeTypeQName the type of the node
+     * @return Returns a new node of the given type and attached to the store
+     * @throws InvalidTypeException if the node type is invalid or if the node type
+     *      is not a valid real node
+     */
+    public Node newNode(Store store, String id, QName nodeTypeQName) throws InvalidTypeException;
+    
+    /**
+     * @param protocol the store protocol
+     * @param identifier the store identifier for the given protocol
+     * @param id the store-specific node identifier
+     * @return Returns the <b>node</b> entity
+     */
+    public Node getNode(String protocol, String identifier, String id);
+    
+    /**
+     * Deletes the node instance, taking care of any cascades that are required over
+     * and above those provided by the persistence mechanism.
+     * <p>
+     * A caller must able to delete the node using this method and not have to follow
+     * up with any other ancillary deletes
+     * 
+     * @param node the entity to delete
+     * @param cascade true if the assoc deletions must cascade to primary child nodes
+     */
+    public void deleteNode(Node node, boolean cascade);
+    
+    /**
+     * @return Returns the persisted and filled association
+     * 
+     * @see ChildAssoc
+     */
+    public ChildAssoc newChildAssoc(
+            Node parentNode,
+            Node childNode,
+            boolean isPrimary,
+            QName assocTypeQName,
+            QName qname);
+
+    /**
+     * @return Returns a matching association or null if one was not found
+     * 
+     * @see ChildAssoc
+     */
+    public ChildAssoc getChildAssoc(
+            Node parentNode,
+            Node childNode,
+            QName assocTypeQName,
+            QName qname);
+            
+    
+    /**
+     * @param assoc the child association to remove
+     * @param cascade true if the assoc deletions must cascade to primary child nodes
+     */
+    public void deleteChildAssoc(ChildAssoc assoc, boolean cascade);
+    
+    /**
+     * Finds the association between the node's primary parent and the node itself
+     * 
+     * @param node the child node
+     * @return Returns the primary <code>ChildAssoc</code> instance where the given node is the child.
+     *      The return value could be null for a root node - but ONLY a root node
+     */
+    public ChildAssoc getPrimaryParentAssoc(Node node);
+    
+    /**
+     * @return Returns the persisted and filled association
+     * @see NodeAssoc
+     */
+    public NodeAssoc newNodeAssoc(
+            Node sourceNode,
+            Node targetNode,
+            QName assocTypeQName);
+    
+    /**
+     * @return Returns the node association or null if not found
+     */
+    public NodeAssoc getNodeAssoc(
+            Node sourceNode,
+            Node targetNode,
+            QName assocTypeQName);
+    
+    /**
+     * @return Returns the target nodes for the association
+     */
+    public Collection<Node> getNodeAssocTargets(Node sourceNode, QName assocTypeQName);
+    
+    /**
+     * @return Returns the source nodes for the association
+     */
+    public Collection<Node> getNodeAssocSources(Node targetNode, QName assocTypeQName);
+    
+    /**
+     * @param assoc the node association to remove
+     */
+    public void deleteNodeAssoc(NodeAssoc assoc);
+    
+    /**
+     * Gets the node's status.  If the node <i>never</i> existed, then
+     * <code>null</code> is returned.
+     * 
+     * @param protocol the store protocol
+     * @param identifier the store identifier for the given protocol
+     * @param id the store-specific node status identifier
+     * @return Returns the node status if the node exists or once existed, otherwise
+     *      returns <code>null</code>.
+     */
+    public NodeStatus getNodeStatus(String protocol, String identifier, String id);
+}