]> git.aero2k.de Git - tmp/jakarta-migration.git/commitdiff
CSPACE-1192 added package.htmls and overview.html for the common services
authorSanjay Dalal <sanjay.dalal@berkeley.edu>
Tue, 30 Mar 2010 22:54:34 +0000 (22:54 +0000)
committerSanjay Dalal <sanjay.dalal@berkeley.edu>
Tue, 30 Mar 2010 22:54:34 +0000 (22:54 +0000)
test: mvn javadoc:aggregate

A    common/src/main/javadoc
A    common/src/main/javadoc/org
A    common/src/main/javadoc/org/collectionspace
A    common/src/main/javadoc/org/collectionspace/services
A    common/src/main/javadoc/org/collectionspace/services/common
A    common/src/main/javadoc/org/collectionspace/services/common/repository
A    common/src/main/javadoc/org/collectionspace/services/common/repository/package.html
A    common/src/main/javadoc/org/collectionspace/services/common/context
A    common/src/main/javadoc/org/collectionspace/services/common/context/package.html
A    common/src/main/javadoc/org/collectionspace/services/common/storage
A    common/src/main/javadoc/org/collectionspace/services/common/storage/jpa
A    common/src/main/javadoc/org/collectionspace/services/common/storage/jpa/package.html
A    common/src/main/javadoc/org/collectionspace/services/common/storage/package.html
A    common/src/main/javadoc/org/collectionspace/services/common/query
A    common/src/main/javadoc/org/collectionspace/services/common/query/nuxeo
A    common/src/main/javadoc/org/collectionspace/services/common/query/nuxeo/package.html
A    common/src/main/javadoc/org/collectionspace/services/common/query/package.html
A    common/src/main/javadoc/org/collectionspace/services/common/config
A    common/src/main/javadoc/org/collectionspace/services/common/config/package.html
A    common/src/main/javadoc/org/collectionspace/services/common/security
A    common/src/main/javadoc/org/collectionspace/services/common/security/package.html
A    common/src/main/javadoc/org/collectionspace/services/common/vocabulary
A    common/src/main/javadoc/org/collectionspace/services/common/vocabulary/package.html
A    common/src/main/javadoc/org/collectionspace/services/common/relation
A    common/src/main/javadoc/org/collectionspace/services/common/relation/nuxeo
A    common/src/main/javadoc/org/collectionspace/services/common/relation/nuxeo/package.html
A    common/src/main/javadoc/org/collectionspace/services/common/relation/package.html
A    common/src/main/javadoc/org/collectionspace/services/common/document
A    common/src/main/javadoc/org/collectionspace/services/common/document/package.html
A    common/src/main/javadoc/org/collectionspace/services/common/package.html
A    common/src/main/javadoc/org/collectionspace/services/nuxeo
A    common/src/main/javadoc/org/collectionspace/services/nuxeo/util
A    common/src/main/javadoc/org/collectionspace/services/nuxeo/util/package.html
A    common/src/main/javadoc/org/collectionspace/services/nuxeo/client
A    common/src/main/javadoc/org/collectionspace/services/nuxeo/client/java
A    common/src/main/javadoc/org/collectionspace/services/nuxeo/client/java/package.html
A    common/src/main/javadoc/org/collectionspace/services/nuxeo/client/package.html
A    common/src/main/javadoc/org/collectionspace/services/nuxeo/package.html
A    common/src/main/javadoc/overview.html

18 files changed:
services/common/src/main/javadoc/org/collectionspace/services/common/config/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/common/context/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/common/document/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/common/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/common/query/nuxeo/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/common/query/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/common/relation/nuxeo/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/common/relation/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/common/repository/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/common/security/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/common/storage/jpa/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/common/storage/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/common/vocabulary/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/nuxeo/client/java/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/nuxeo/client/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/nuxeo/package.html [new file with mode: 0644]
services/common/src/main/javadoc/org/collectionspace/services/nuxeo/util/package.html [new file with mode: 0644]
services/common/src/main/javadoc/overview.html [new file with mode: 0644]

diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/config/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/config/package.html
new file mode 100644 (file)
index 0000000..f1181ff
--- /dev/null
@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for managing various service layer configuration
+        files such as tenant bindings, service bindings, etc.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/context/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/context/package.html
new file mode 100644 (file)
index 0000000..cef6889
--- /dev/null
@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for managing several types of request contexts 
+        in the CollectionSpace services.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/document/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/document/package.html
new file mode 100644 (file)
index 0000000..0635037
--- /dev/null
@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for processing documents in CollectionSpace
+        services.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/package.html
new file mode 100644 (file)
index 0000000..b958bb4
--- /dev/null
@@ -0,0 +1,53 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+
+        Provides classes and interfaces for common layer of CollectionSpace Services.
+        The common layer includes has IoC framework for document management, context
+        management, tenant and service binding management, relationship management,
+        vocabulary management, repository/storage management, etc.  
+       
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/query/nuxeo/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/query/nuxeo/package.html
new file mode 100644 (file)
index 0000000..a1e1778
--- /dev/null
@@ -0,0 +1,49 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for query service provider using Nuxeo.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/query/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/query/package.html
new file mode 100644 (file)
index 0000000..37568af
--- /dev/null
@@ -0,0 +1,49 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for CollectionSpace query manager.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/relation/nuxeo/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/relation/nuxeo/package.html
new file mode 100644 (file)
index 0000000..d7a029e
--- /dev/null
@@ -0,0 +1,49 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for relationship management using Nuxeo.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/relation/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/relation/package.html
new file mode 100644 (file)
index 0000000..2c52fa1
--- /dev/null
@@ -0,0 +1,49 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for relationship management for CollectionSpace services.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/repository/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/repository/package.html
new file mode 100644 (file)
index 0000000..9d298ff
--- /dev/null
@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for a repository service provider interface (SPI) 
+        in CollectionSpace services layer
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/security/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/security/package.html
new file mode 100644 (file)
index 0000000..bf16280
--- /dev/null
@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces providing utilities and interception points
+        to CollectionSpace services.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/storage/jpa/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/storage/jpa/package.html
new file mode 100644 (file)
index 0000000..ddeb8d1
--- /dev/null
@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for storage management using Java
+        Persistence APIs (JPA).
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/storage/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/storage/package.html
new file mode 100644 (file)
index 0000000..76536cb
--- /dev/null
@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for storage management service provider
+        interface (SPI) in CollectionSpace.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/common/vocabulary/package.html b/services/common/src/main/javadoc/org/collectionspace/services/common/vocabulary/package.html
new file mode 100644 (file)
index 0000000..575c872
--- /dev/null
@@ -0,0 +1,49 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for vocabulary management for CollectionSpace Services.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/nuxeo/client/java/package.html b/services/common/src/main/javadoc/org/collectionspace/services/nuxeo/client/java/package.html
new file mode 100644 (file)
index 0000000..b952724
--- /dev/null
@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for accessing Nuxeo remotely
+        using Nuxeo Java Remote APIs.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/nuxeo/client/package.html b/services/common/src/main/javadoc/org/collectionspace/services/nuxeo/client/package.html
new file mode 100644 (file)
index 0000000..8c6d646
--- /dev/null
@@ -0,0 +1,49 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for accessing the Nuxeo remotely.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/nuxeo/package.html b/services/common/src/main/javadoc/org/collectionspace/services/nuxeo/package.html
new file mode 100644 (file)
index 0000000..57fd3fa
--- /dev/null
@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides classes and interfaces for interfacing with Nuxeo
+        from CollectionSpace service.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/org/collectionspace/services/nuxeo/util/package.html b/services/common/src/main/javadoc/org/collectionspace/services/nuxeo/util/package.html
new file mode 100644 (file)
index 0000000..8636790
--- /dev/null
@@ -0,0 +1,49 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+    <head>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+    </head>
+    <body bgcolor="white">
+
+        Provides Nuxeo related utility classes.
+
+        <h2>Package Specification</h2>
+
+
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <h2>Related Documentation</h2>
+
+        For overviews, tutorials, examples, guides, and tool documentation, please see:
+        <ul>
+            <li><a href=""></a>
+        </ul>
+
+        <!-- Put @see and @since tags down here. -->
+
+    </body>
+</html>
diff --git a/services/common/src/main/javadoc/overview.html b/services/common/src/main/javadoc/overview.html
new file mode 100644 (file)
index 0000000..c424146
--- /dev/null
@@ -0,0 +1,43 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+    <HEAD>
+        <!--
+         This document is a part of the source code and related artifacts
+         for CollectionSpace, an open source collections management system
+         for museums and related institutions:
+
+         http://www.collectionspace.org
+         http://wiki.collectionspace.org
+
+         Copyright 2010 University of California at Berkeley
+
+         Licensed under the Educational Community License (ECL), Version 2.0.
+         You may not use this file except in compliance with this License.
+
+         You may obtain a copy of the ECL 2.0 License at
+
+         https://source.collectionspace.org/collection-space/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.
+        -->
+
+        <TITLE>Account Service Overview</TITLE>
+    </HEAD>
+    <BODY>
+        This document describes the internal Application Programming Interface (API) 
+        of CollectionSpace common service layer. The APIs are for document processing framework,
+        context management, repository access, vocabulary management, relationship
+        management, etc. There are several Service Provider Interface (SPI)s for 
+        repository and storage management. 
+        <br/>
+        It includes the classes and interfaces for the following.
+        <br/>
+        - Java XML bindings for account
+        - Service side source including RESTful web service resource and persistence
+          management
+    </BODY>
+</HTML>