Changeset 6004 for DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/dao/NotebookDao.java

Timestamp:

02/20/15 15:17:07 (9 years ago)

Author:

olhsha@mpi.nl

Message:

Javadoc are updated for the interfaces NotebookDao?, ResourceDao?, TargetDao? and some helpers.

File:

• DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/dao/NotebookDao.java (modified) (6 diffs)

DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/dao/NotebookDao.java

@@ -43 +43 @@
   **/
     
+    /**
+     * 
+     * @param notebookID the internal ID of a notebook.
+     * @return the internal database Id of the owner of the notebook.
+     */
     Number getOwner(Number notebookID);
     
     
-    
+    /**
+     * 
+     * @param principalID the internal database id of some principal.
+     * @param acessMode {@link Access} object, representing one of the access modes: 
+     * "all", "write", "read" or "none".
+     * @return the list of internal database id's of the notebooks for which "principalID" has ""accessMode" access.
+     */
     List<Number> getNotebookIDs(Number principalID, Access acessMode);
     
-    // Returns a list of notebook Ids for the notebooks for which the given principal "principalID" is the owner.
+   /** 
+    * @param principaID the internal database id of some principal.
+    * @return  the list of internal database id's of the notebooks for which "principalID" is the owner.
+    */
     List<Number> getNotebookIDsOwnedBy(Number principaID);
     
@@ -56 +70 @@
     /**
      * 
-     * @param notebookID
-     * @return the notebook info for the notebook with notebookID
+     * @param notebookID the internal database id of a notebook.
+     * @return the {@link NotebookInfo} object built for the notebook with notebookID upon the corresponding row
+     * in the "notebook" table.
      */
     NotebookInfo getNotebookInfoWithoutOwner(Number notebookID);
@@ -64 +79 @@
     /**
      * 
-     * @param notebookID
-     * @return notebook metadata for the notebook with notebookID
+     * @param notebookID the internal database id of a notebook.
+     * @return the {@link Notebook} object built for the notebook with notebookID upon the corresponding row
+     * in the "notebook" table.
      */
     Notebook getNotebookWithoutAnnotationsAndAccesssAndOwner(Number notebookID);
@@ -81 +97 @@
     
     
-    /**
-     * 
-     * @param notebookID
-     * @return true if updated, false otherwise. Logs the reason if the notebook is not updated.
+
+    /**
+     * 
+     * @param notebookID the internal database id of a notebook.
+     * @param title a new title for the notebook.
+     * @param ownerID the internal database id of the owner principal of the notebook.
+     * @return true if the title "notebookID" is updated to "title", false otherwise.
      */
     boolean updateNotebookMetadata(Number notebookID, String title, Number ownerID);
     
+    
+    /**
+     * 
+     * @param notebookID the internal database id of a notebook.
+     * @param ownerID the internal database id of a new owner for the notebook.
+     * @return true if the owner_id is in "notebook" table is updated to "ownerID", false otherwise.
+     */
     boolean setOwner(Number notebookID, Number ownerID);
     
+    /**
+     * 
+     * @param notebookID the internal database id of a notebook.
+     * @param principalID the internal database id of a principal.
+     * @param access an {@link Access} object.
+     * @return true iff the access mode to "notebookID" for "principalID" has been assigned to "access"'s value.
+     */
     boolean updatePrincipalAccessForNotebook(Number notebookID, Number principalID, Access access);
     
@@ -99 +132 @@
      */
     
+    /**
+     * 
+     * @param notebook the {@link Notebook} object representing a notebook to be created in the database.
+     * @param ownerID the internal database id of the owner principal.
+     * @return the internal id of the created notebook.
+     * @throws NotInDataBaseException if creation the notebook fails. 
+     */
     public Number createNotebookWithoutAccesssAndAnnotations(Notebook notebook, Number ownerID) throws NotInDataBaseException;
     
+    /**
+     * 
+     * @param notebookID the internal database ID of a notebook.
+     * @param annotationID the internal database ID of an annotation.
+     * @return  true if the row for the (ntebookID,annotationID) has been added to the junction table 
+     * "notebooks_annotations".
+     */
     boolean addAnnotationToNotebook(Number notebookID, Number annotationID);
     
+    /**
+     * 
+     * @param notebookID the internal database ID of a notebook.
+     * @param principalID the internal database ID of a principal.
+     * @param access access an {@link Access} object.
+     * @return true iff the "access" mode to "notebookID" has been assigned for "principalID" 
+     * in the corresponding junction table.
+     */
     boolean addAccessToNotebook(Number notebookID, Number principalID, Access access);
     
@@ -114 +169 @@
      */
     
+    /**
+     * 
+     * @param notebookID the internal database ID of a notebook.
+     * @param annotationID annotationID the internal database ID of an annotation.
+     * @return  true iff the row for the (notebookID,annotationID) has been deleted from the junction table 
+     * "notebooks_annotations".
+     */
     boolean deleteAnnotationFromNotebook(Number notebookID, Number annotationID);
     
+    /**
+     * 
+     * @param notebookID the internal database ID of a notebook.
+     * @return true iff all the rows with "notebookID" have been removed from "notebooks_annotations" table.
+     */
     boolean deleteAllAnnotationsFromNotebook(Number notebookID);
     
+    /**
+     * 
+     * @param notebookID the internal database ID of a notebook.
+     * @param principalID the internal database ID of a principal.
+     * @return true iff the row for the pair (notebookID, principlaID) has been removed from the "notebooks_principals_accesses" table.
+     */
     boolean deleteNotebookPrincipalAccess(Number notebookID, Number principalID);
     
+    /**
+     * 
+     * @param notebookID the internal database ID of a notebook.
+     * @return true iff all the rows with "notebookID" have been removed from from the "notebooks_principals_accesses" table.
+     */
     boolean deleteAllAccesssForNotebook(Number notebookID);
     
+    /**
+     * 
+     * @param notebookID the internal database ID of a notebook.
+     * @return true iff the notebook with "notebookID" has been removed from the "notebook" table.
+     */
     boolean deleteNotebook(Number notebookID);
 }