]> git.aero2k.de Git - tmp/jakarta-migration.git/commitdiff
NOJIRA: Adding JavaDoc comments.
authorRichard Millet <richard.millet@berkeley.edu>
Tue, 4 Aug 2009 20:28:56 +0000 (20:28 +0000)
committerRichard Millet <richard.millet@berkeley.edu>
Tue, 4 Aug 2009 20:28:56 +0000 (20:28 +0000)
services/common/src/main/java/org/collectionspace/services/nuxeo/util/NuxeoUtils.java

index 35fc566750acb97baa7082d77f1de05c5d2c5b92..bd459d1ddb995df278b22f77e7f6d5021da35902 100644 (file)
@@ -47,6 +47,7 @@ import org.slf4j.LoggerFactory;
  */
 public class NuxeoUtils {
 
+    /** The logger. */
     private static Logger logger = LoggerFactory.getLogger(NuxeoUtils.class);
 
     /**
@@ -104,6 +105,16 @@ public class NuxeoUtils {
         return doc;
     }
     
+/**
+ * Gets the document.
+ * 
+ * @param repoSession the repo session
+ * @param csid the csid
+ * 
+ * @return the document
+ * 
+ * @throws DocumentException the document exception
+ */
 public static Document getDocument(RepositoryInstance repoSession, String csid)
        throws DocumentException {
                Document result = null;
@@ -114,6 +125,18 @@ public static Document getDocument(RepositoryInstance repoSession, String csid)
                return result;
        }
        
+       /**
+        * Gets the workspace model.
+        * 
+        * @param repoSession the repo session
+        * @param workspaceName the workspace name
+        * 
+        * @return the workspace model
+        * 
+        * @throws DocumentException the document exception
+        * @throws IOException Signals that an I/O exception has occurred.
+        * @throws ClientException the client exception
+        */
        public static DocumentModel getWorkspaceModel(
                        RepositoryInstance repoSession, String workspaceName)
                        throws DocumentException, IOException, ClientException {
@@ -127,6 +150,16 @@ public static Document getDocument(RepositoryInstance repoSession, String csid)
                return result;
        }
 
+       /**
+        * Gets the document model.
+        * 
+        * @param repoSession the repo session
+        * @param csid the csid
+        * 
+        * @return the document model
+        * 
+        * @throws DocumentException the document exception
+        */
        public static DocumentModel getDocumentModel(
                        RepositoryInstance repoSession, String csid)
                        throws DocumentException {