Index: lams_tool_nb/src/java/org/lamsfoundation/lams/tool/noticeboard/NoticeboardAttachment.java =================================================================== diff -u -ra6857cd86c7c1a7e32287da94351b4db9ee098ef -rc37fcfa0e8e9c09a5ada45fba5af63e43b2bbef1 --- lams_tool_nb/src/java/org/lamsfoundation/lams/tool/noticeboard/NoticeboardAttachment.java (.../NoticeboardAttachment.java) (revision a6857cd86c7c1a7e32287da94351b4db9ee098ef) +++ lams_tool_nb/src/java/org/lamsfoundation/lams/tool/noticeboard/NoticeboardAttachment.java (.../NoticeboardAttachment.java) (revision c37fcfa0e8e9c09a5ada45fba5af63e43b2bbef1) @@ -21,9 +21,6 @@ /* * Created on Jul 28, 2005 - * - * TODO To change the template for this generated file go to - * Window - Preferences - Java - Code Style - Code Templates */ package org.lamsfoundation.lams.tool.noticeboard; @@ -32,20 +29,36 @@ /** + *

This class represents a file that is uploaded to the noticeboard tool. + * It is used in the authoring environment, when an author + * uploads an online/offline instructions file. The file is actually stored + * in the content repository, however, the file details will be stored in the + * tl_lanb11_attachment table. The file uploaded, will be of two types: online or offline. + *

+ * * @author mtruong - * - * TODO To change the template for this generated type comment go to - * Window - Preferences - Java - Code Style - Code Templates */ public class NoticeboardAttachment implements Serializable { + /** identifier field */ private Long attachmentId; + + /** persistent field. Cannot be null */ private NoticeboardContent nbContent; + + /** persistent field. Cannot be null */ private String filename; + + /** unique persistent field. Cannot be null */ private Long uuid; + + /** nullable persistent field */ private Long versionId; + + /** persistent field. Cannot be null. It can either take values "ONLINE" or "OFFLINE" */ private boolean onlineFile; + /** The two different types of files/attachment that can be uploaded */ public final static String TYPE_ONLINE = "ONLINE"; public final static String TYPE_OFFLINE = "OFFLINE"; @@ -79,11 +92,6 @@ /** - * @hibernate.id - * generator-class="native" - * type="java.lang.Long" - * column="attachment_id" - * * @return Returns the attachmentId. */ public Long getAttachmentId() { @@ -98,11 +106,6 @@ } /** - * @hibernate.property - * column="filename" - * length="255" - * not-null="true" - * * @return Returns the filename. */ public String getFilename() { @@ -116,11 +119,6 @@ } /** - * @hibernate.property - * column="online_file" - * length="1" - * not-null="true" - * * @return Returns the isOnline. */ public boolean isOnlineFile() { @@ -134,10 +132,6 @@ } /** - * @hibernate.many-to-one - * not-null="true" - * @hibernate.column name="nb_content_uid" - * * @return Returns the nbContent. */ public NoticeboardContent getNbContent() { @@ -151,11 +145,6 @@ } /** - * @hibernate.property - * column="uuid" - * length="20" - * not-null="true" - * * @return Returns the uuid. */ public Long getUuid() { @@ -169,13 +158,9 @@ } /** - * @hibernate.property - * column="version_id" - * length="20" - * * @return Returns the versionId. */ - public Long getVersionId() { + public Long getVersionId() { //nullable return versionId; } /** Index: lams_tool_nb/src/java/org/lamsfoundation/lams/tool/noticeboard/NoticeboardContent.java =================================================================== diff -u -r84b30ae2fdf0e1471e2ce86a850517330d63d177 -rc37fcfa0e8e9c09a5ada45fba5af63e43b2bbef1 --- lams_tool_nb/src/java/org/lamsfoundation/lams/tool/noticeboard/NoticeboardContent.java (.../NoticeboardContent.java) (revision 84b30ae2fdf0e1471e2ce86a850517330d63d177) +++ lams_tool_nb/src/java/org/lamsfoundation/lams/tool/noticeboard/NoticeboardContent.java (.../NoticeboardContent.java) (revision c37fcfa0e8e9c09a5ada45fba5af63e43b2bbef1) @@ -26,12 +26,11 @@ import java.util.HashSet; -import org.apache.commons.lang.builder.EqualsBuilder; /** - * Persistent noticeboard object/bean that defines the content for the noticeboard tool. - * Provides accessors and mutators to get/set noticeboard attributes + *

Persistent noticeboard object/bean that defines the content for the noticeboard tool. + * Provides accessors and mutators to get/set noticeboard attributes

+ * * @author mtruong - * */ public class NoticeboardContent implements Serializable { Index: lams_tool_nb/src/java/org/lamsfoundation/lams/tool/noticeboard/NoticeboardSession.java =================================================================== diff -u -r0539495b645c71f741d28f269584fcfb933cfe0c -rc37fcfa0e8e9c09a5ada45fba5af63e43b2bbef1 --- lams_tool_nb/src/java/org/lamsfoundation/lams/tool/noticeboard/NoticeboardSession.java (.../NoticeboardSession.java) (revision 0539495b645c71f741d28f269584fcfb933cfe0c) +++ lams_tool_nb/src/java/org/lamsfoundation/lams/tool/noticeboard/NoticeboardSession.java (.../NoticeboardSession.java) (revision c37fcfa0e8e9c09a5ada45fba5af63e43b2bbef1) @@ -27,8 +27,17 @@ import java.util.Set; /** + *

The NoticeboardSession class represents a tool session for a noticeboard activity. + * Each tool session may represent a group of users, if grouping is used, or may + * represent one learner if there is no grouping for this particular activity. + *

+ *
+ *

The session status has three possible status': + *

* @author mtruong - * */ public class NoticeboardSession implements Serializable { Index: lams_tool_nb/src/java/org/lamsfoundation/lams/tool/noticeboard/NoticeboardUser.java =================================================================== diff -u -rf2eb6b655a4d80d99bc933396eadae540a413b6a -rc37fcfa0e8e9c09a5ada45fba5af63e43b2bbef1 --- lams_tool_nb/src/java/org/lamsfoundation/lams/tool/noticeboard/NoticeboardUser.java (.../NoticeboardUser.java) (revision f2eb6b655a4d80d99bc933396eadae540a413b6a) +++ lams_tool_nb/src/java/org/lamsfoundation/lams/tool/noticeboard/NoticeboardUser.java (.../NoticeboardUser.java) (revision c37fcfa0e8e9c09a5ada45fba5af63e43b2bbef1) @@ -28,8 +28,16 @@ /** * @author mtruong * - * TODO To change the template for this generated type comment go to - * Window - Preferences - Java - Code Style - Code Templates + *

The NoticeboardUser class represents the learners that will participate + * the noticeboard activity. Each learner will have a tool session id which represents + * which group they belong to, or there is no grouping, then each learner will have their own + * tool session id.

+ *

The userStatus can be of two values + *