performed javacscript:fix and worked on documentation
[taxeditor.git] / taxeditor-editor / src / main / java / eu / etaxonomy / taxeditor / dialogs / filteredSelection / FilteredAgentSelectionDialog.java
index bed764bace5989e717b2f1c8b02fe3629f77c320..0a18721e0bffb0931e15506b0327ab6e3aef4f5b 100644 (file)
@@ -25,6 +25,8 @@ import eu.etaxonomy.taxeditor.editor.newWizard.AbstractNewEntityWizard;
 import eu.etaxonomy.taxeditor.store.CdmStore;
 
 /**
+ * <p>FilteredAgentSelectionDialog class.</p>
+ *
  * @author n.hoffmann
  * @created Sep 10, 2009
  * @version 1.0
@@ -32,6 +34,14 @@ import eu.etaxonomy.taxeditor.store.CdmStore;
 public class FilteredAgentSelectionDialog extends
                AbstractFilteredCdmResourceSelectionDialog<AgentBase> {
        
+       /**
+        * <p>select</p>
+        *
+        * @param shell a {@link org.eclipse.swt.widgets.Shell} object.
+        * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
+        * @param entity a {@link eu.etaxonomy.cdm.model.agent.AgentBase} object.
+        * @return a {@link eu.etaxonomy.cdm.model.agent.AgentBase} object.
+        */
        public static AgentBase select(Shell shell, ConversationHolder conversation, AgentBase entity) {
                FilteredAgentSelectionDialog dialog = new FilteredAgentSelectionDialog(shell, conversation,
                                "Choose Agent", false, FilteredAgentSelectionDialog.class.getCanonicalName(), entity);
@@ -39,10 +49,15 @@ public class FilteredAgentSelectionDialog extends
        }
        
        /**
-       * @param shell
-       * @param title
-        * @param agent 
-       */
+        * <p>Constructor for FilteredAgentSelectionDialog.</p>
+        *
+        * @param shell a {@link org.eclipse.swt.widgets.Shell} object.
+        * @param title a {@link java.lang.String} object.
+        * @param agent a {@link eu.etaxonomy.cdm.model.agent.AgentBase} object.
+        * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
+        * @param multi a boolean.
+        * @param settings a {@link java.lang.String} object.
+        */
        protected FilteredAgentSelectionDialog(Shell shell, ConversationHolder conversation, String title, boolean multi, String settings, AgentBase agent) {
                super(shell, conversation, title, multi, settings, agent);
        }
@@ -70,31 +85,36 @@ public class FilteredAgentSelectionDialog extends
        /* (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.dialogs.AbstractFilteredCdmResourceSelectionDialog#getPersistentObect(java.util.UUID)
         */
+       /** {@inheritDoc} */
        @Override
        protected AgentBase getPersistentObject(UUID cdmUuid) {
                return CdmStore.getAgentService().load(cdmUuid);
        }
 
+       /** {@inheritDoc} */
        @Override
        protected AbstractNewEntityWizard getNewEntityWizard() {
                return null;
        }
 
+       /** {@inheritDoc} */
        @Override
        protected String getNewWizardLinkText() {
                return "Create a new <a>Team</a> or <a>Person</a>";
        }
        
+       /** {@inheritDoc} */
        @Override
        protected Control createExtendedContentArea(Composite parent) {
                // nothing at the moment
                return null;
        }
 
+       /** {@inheritDoc} */
        @Override
        protected void initModel() {
                model = CdmStore.getAgentService().getUuidAndTitleCache();
        }
 
 
-}
\ No newline at end of file
+}