JavaDoc für ccm-sci-types-institute

git-svn-id: https://svn.libreccm.org/ccm/trunk@1366 8810af33-2d31-482b-a856-94f89814c4df

ccm-sci-types-institute/src/com/arsdigita/cms/contenttypes/SciInstitute.java

@@ -9,10 +9,10 @@ import com.arsdigita.persistence.OID;
 import com.arsdigita.persistence.SessionManager;
 import java.math.BigDecimal;
 import java.util.List;
-import org.omg.PortableInterceptor.ACTIVE;
 
 /**
- *
+ * An content type for representing scientifc institutes.
+ * 
  * @author Jens Pelzetter 
  * @version $Id$
  */
@@ -90,6 +90,12 @@ public class SciInstitute extends GenericOrganizationalUnit {
         return result;
     }
 
+    /**
+     * Used to check if a institute has members with a specific status.
+     * @param merge
+     * @param status
+     * @return 
+     */
     public boolean hasMembers(final boolean merge,
                               final SciInstituteMemberStatus status) {
         String queryName;

ccm-sci-types-institute/src/com/arsdigita/cms/contenttypes/SciInstituteInitializer.java

@@ -28,6 +28,7 @@ public class SciInstituteInitializer extends ContentTypeInitializer {
 
         final SciInstituteConfig config = SciInstitute.getConfig();
 
+        //Add the authoring steps for departments if the department type is installed
         final ContentTypeCollection contentTypes = ContentType.
                 getAllContentTypes();
         contentTypes.addFilter(
@@ -58,6 +59,8 @@ public class SciInstituteInitializer extends ContentTypeInitializer {
         }
 
         contentTypes.reset();
+
+        //Add the authoring steps for projects if the project type is installed
         contentTypes.addFilter(
                 "associatedObjectType = 'com.arsdigita.cms.contenttypes.SciProject'");
 

ccm-sci-types-institute/src/com/arsdigita/cms/contenttypes/ui/SciDepartmentInstitutesStep.java

@@ -2,13 +2,19 @@ package com.arsdigita.cms.contenttypes.ui;
 
 import com.arsdigita.cms.ItemSelectionModel;
 import com.arsdigita.cms.contenttypes.SciInstitute;
+import com.arsdigita.cms.contenttypes.SciInstituteInitializer;
 import com.arsdigita.cms.ui.authoring.AuthoringKitWizard;
 import com.arsdigita.cms.ui.authoring.BasicItemForm;
 import com.arsdigita.cms.ui.authoring.SimpleEditStep;
 import com.arsdigita.cms.ui.workflow.WorkflowLockedComponentAccess;
 
 /**
- *
+ * Authoring step for associating departments to an institute
+ * This step is attached by the {@link SciInstituteInitializer} only if
+ * the ccm-sci-types-department module has been installed and the config 
+ * parameter {@code com.arsdigita.cms.contenttypes.sciinstitute.enable.department_institutes_step} 
+ * is set to true.
+ *  
  * @author Jens Pelzetter 
  * @version $Id$
  */

ccm-sci-types-institute/src/com/arsdigita/cms/contenttypes/ui/SciInstituteDepartmentsStep.java

@@ -7,7 +7,10 @@ import com.arsdigita.cms.ui.authoring.SimpleEditStep;
 import com.arsdigita.cms.ui.workflow.WorkflowLockedComponentAccess;
 
 /**
- *
+ * Authoring step for adding departments to an institute. This step is
+ * attached by the initializer if the ccm-sci-types-department module 
+ * has been installed.
+ * 
  * @author Jens Pelzetter 
  * @version $Id$
  */

ccm-sci-types-institute/src/com/arsdigita/cms/contenttypes/ui/SciInstituteDescTab.java

@@ -7,7 +7,8 @@ import com.arsdigita.xml.Element;
 import org.apache.log4j.Logger;
 
 /**
- *
+ * Tab which shown the description of an institute.
+ * 
  * @author Jens Pelzetter 
  * @version $Id$
  */

ccm-sci-types-institute/src/com/arsdigita/cms/contenttypes/ui/SciInstituteMembersStep.java

@@ -9,7 +9,8 @@ import com.arsdigita.cms.ui.authoring.SimpleEditStep;
 import com.arsdigita.cms.ui.workflow.WorkflowLockedComponentAccess;
 
 /**
- *
+ * 
+ * 
  * @author Jens Pelzetter 
  * @version $Id$
  */

ccm-sci-types-institute/src/com/arsdigita/cms/contenttypes/ui/SciInstituteMembersTab.java

@@ -20,7 +20,8 @@ import javax.servlet.http.HttpServletRequest;
 import org.apache.log4j.Logger;
 
 /**
- *
+ * Tab for showing a list of members of an institute.
+ * 
  * @author Jens Pelzetter 
  * @version $Id$
  */

ccm-sci-types-institute/src/com/arsdigita/cms/contenttypes/ui/SciInstituteProjectsStep.java

@@ -7,7 +7,10 @@ import com.arsdigita.cms.ui.authoring.SimpleEditStep;
 import com.arsdigita.cms.ui.workflow.WorkflowLockedComponentAccess;
 
 /**
- *
+ * Authoring step for adding projects to an institute. This step is
+ * attached by the initializer if the ccm-sci-types-project module has been 
+ * installed.
+ * 
  * @author Jens Pelzetter 
  * @version $Id$
  */

ccm-sci-types-institute/src/com/arsdigita/cms/contenttypes/ui/SciInstituteProjectsTab.java

@@ -26,7 +26,9 @@ import javax.servlet.http.HttpServletRequest;
 import org.apache.log4j.Logger;
 
 /**
- *
+ * Shows a list of projects of an institute. Projects of departments are merged 
+ * into the list.
+ * 
  * @author Jens Pelzetter 
  * @version $Id$
  */

ccm-sci-types-institute/src/com/arsdigita/cms/contenttypes/ui/SciProjectInstitutesStep.java

@@ -8,7 +8,11 @@ import com.arsdigita.cms.ui.authoring.SimpleEditStep;
 import com.arsdigita.cms.ui.workflow.WorkflowLockedComponentAccess;
 
 /**
- *
+ * Step for associating a project with institutes. Activated if the
+ * ccm-sci-types-project module is installed and the 
+ * {@code com.arsdigita.cms.contenttypes.sciinstitute.enable.project_institutes_step} 
+ * is set to true.
+ * 
  * @author Jens Pelzetter  
  * @version $Id$
  */