Added missing LGPL notices and documentation to new files.

7 files changed, 130 insertions, 3 deletions

diff --git a/src/main/java/com/capitati/omtc/core/resources/IDerivedResource.java b/src/main/java/com/capitati/omtc/core/resources/IDerivedResource.java
index 51ce2fa..9887436 100644
--- a/src/main/java/com/capitati/omtc/core/resources/IDerivedResource.java
+++ b/src/main/java/com/capitati/omtc/core/resources/IDerivedResource.java
@@ -18,8 +18,19 @@
  */
 package com.capitati.omtc.core.resources;
 
-import java.util.Date;
+import java.util.Set;
 
+/**
+ * This is a representation of a resource that is composed of other resources.
+ * A translation engine is a concrete example of this interface.
+ *
+ * @author ian
+ */
 public interface IDerivedResource extends IResource {
-  Date getLastChanged();
+  /**
+   * Retrieve the resources that have been composed to create a derived resource.
+   *
+   * @return A {@link java.util.Set} whose entries are the composed resources.
+   */
+  Set<IResource> getCreationResources();
 }
diff --git a/src/main/java/com/capitati/omtc/core/resources/IGlossary.java b/src/main/java/com/capitati/omtc/core/resources/IGlossary.java
index da05f07..c41ad56 100644
--- a/src/main/java/com/capitati/omtc/core/resources/IGlossary.java
+++ b/src/main/java/com/capitati/omtc/core/resources/IGlossary.java
@@ -1,6 +1,23 @@
+/*
+ * Copyright Capita Translation and Interpreting 2013
+ *
+ * This file is part of OMTC.
+ *
+ * OMTC is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * OMTC is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with OMTC.  If not, see <http://www.gnu.org/licenses/>.
+ */
 package com.capitati.omtc.core.resources;
 
-
 /**
  * A glossary.
  * 
diff --git a/src/main/java/com/capitati/omtc/core/resources/IPrimaryResource.java b/src/main/java/com/capitati/omtc/core/resources/IPrimaryResource.java
index e62941b..8750988 100644
--- a/src/main/java/com/capitati/omtc/core/resources/IPrimaryResource.java
+++ b/src/main/java/com/capitati/omtc/core/resources/IPrimaryResource.java
@@ -18,6 +18,12 @@
  */
 package com.capitati.omtc.core.resources;
 
+/**
+ * A resource that is created outside of an MT system and is made available
+ * once the MT system has received, e.g. uploading.
+ *
+ * @author ian
+ */
 public interface IPrimaryResource extends IResource {
 
 }
diff --git a/src/main/java/com/capitati/omtc/core/resources/IResource.java b/src/main/java/com/capitati/omtc/core/resources/IResource.java
index 72787df..918af47 100644
--- a/src/main/java/com/capitati/omtc/core/resources/IResource.java
+++ b/src/main/java/com/capitati/omtc/core/resources/IResource.java
@@ -22,8 +22,32 @@ import java.net.URI;
 import java.util.Date;
 import java.util.UUID;
 
+/**
+ * An abstract and immutable resource. This is anything in OMTC that is used by
+ * a user in an MT system, e.g. documents, translation memories, glossaries etc.
+ *
+ * @author ian
+ */
 public interface IResource {
+  /**
+   * Retrieve the unique identifier for the resource.
+   *
+   * @return A resource's unqiue identifier as a {@link java.util.UUID} object.
+   */
 	UUID getIdentifier();
+
+	/**
+	 * Retrieve the location of the resource. The scheme of the URI shall
+	 * determine how to access the resource; this is implementation defined.
+	 *
+	 * @return A resource's location as a {@link java.net.URI} object.
+	 */
 	URI getURI();
+
+	/**
+	 * Retrieve the creation date of the resource.
+	 *
+	 * @return A resource's creation date as a {@link java.util.Date} object.
+	 */
 	Date getBirthDate();
 }
diff --git a/src/main/java/com/capitati/omtc/core/resources/ITranslationMemory.java b/src/main/java/com/capitati/omtc/core/resources/ITranslationMemory.java
index c3d8730..e59c4c1 100644
--- a/src/main/java/com/capitati/omtc/core/resources/ITranslationMemory.java
+++ b/src/main/java/com/capitati/omtc/core/resources/ITranslationMemory.java
@@ -1,3 +1,21 @@
+/*
+ * Copyright Capita Translation and Interpreting 2013
+ *
+ * This file is part of OMTC.
+ *
+ * OMTC is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * OMTC is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with OMTC.  If not, see <http://www.gnu.org/licenses/>.
+ */
 package com.capitati.omtc.core.resources;
 
 /**
diff --git a/src/main/java/com/capitati/omtc/core/resources/ITranslationResource.java b/src/main/java/com/capitati/omtc/core/resources/ITranslationResource.java
index 430f35b..847fe11 100644
--- a/src/main/java/com/capitati/omtc/core/resources/ITranslationResource.java
+++ b/src/main/java/com/capitati/omtc/core/resources/ITranslationResource.java
@@ -1,3 +1,21 @@
+/*
+ * Copyright Capita Translation and Interpreting 2013
+ *
+ * This file is part of OMTC.
+ *
+ * OMTC is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * OMTC is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with OMTC.  If not, see <http://www.gnu.org/licenses/>.
+ */
 package com.capitati.omtc.core.resources;
 
 import java.util.Map;
diff --git a/src/main/java/com/capitati/omtc/core/security/IRole.java b/src/main/java/com/capitati/omtc/core/security/IRole.java
index 1fa9c29..32b6a6f 100644
--- a/src/main/java/com/capitati/omtc/core/security/IRole.java
+++ b/src/main/java/com/capitati/omtc/core/security/IRole.java
@@ -1,7 +1,40 @@
+/*
+ * Copyright Capita Translation and Interpreting 2013
+ *
+ * This file is part of OMTC.
+ *
+ * OMTC is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * OMTC is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with OMTC.  If not, see <http://www.gnu.org/licenses/>.
+ */
 package com.capitati.omtc.core.security;
 
+/**
+ * A role that can be granted to a user.
+ *
+ * @author ian
+ */
 public interface IRole {
+  /**
+   * Get a unique code for the role
+   *
+   * @return A role's unique code number.
+   */
   int getCode();
 
+  /**
+   * Get the role's name.
+   *
+   * @return A role's name.
+   */
   String getName();
 }