Close #243

Author: Open Lowcode SAS

src/org/openlowcode/design/data/DataObjectDefinitionShowPage.java

@@ -13,6 +13,7 @@
 import java.io.IOException;
 import java.util.ArrayList;
 
+import org.openlowcode.design.action.DynamicActionDefinition;
 import org.openlowcode.design.data.ChoiceValue;
 import org.openlowcode.design.data.DataAccessMethod;
 import org.openlowcode.design.data.DataObjectDefinition;
@@ -27,6 +28,7 @@
 import org.openlowcode.design.generation.SourceGenerator;
 import org.openlowcode.design.generation.StringFormatter;
 import org.openlowcode.design.module.Module;
+import org.openlowcode.tools.misc.NamedList;
 
 /**
  * A Companion is a secondary data object linked to a main data object. It
@@ -42,52 +44,63 @@ public class Companion
 
 	private DataObjectDefinition maintypedobject;
 	private ChoiceValue[] types;
+	private Typed mainobjecttypedproperty;
+	private HasId hasid;
 
-	public Companion(DataObjectDefinition maintypedobject,ChoiceValue[] types) {
+	public Companion(DataObjectDefinition maintypedobject, ChoiceValue[] types) {
 		super("COMPANION");
 		this.maintypedobject = maintypedobject;
 		this.types = types;
-		
+
 	}
 
 	@Override
 	public void controlAfterParentDefinition() {
 
-		Typed mainobjecttypedproperty = (Typed) maintypedobject.getPropertyByName("TYPED");
-		if (mainobjecttypedproperty==null) throw new RuntimeException("Main object "+maintypedobject.getName()+" should have the Typed property added before this statement.");
+		mainobjecttypedproperty = (Typed) maintypedobject.getPropertyByName("TYPED");
+		if (mainobjecttypedproperty == null)
+			throw new RuntimeException("Main object " + maintypedobject.getName()
+					+ " should have the Typed property added before this statement.");
 		mainobjecttypedproperty.addCompanionObject(this.getParent(), types);
-		
+
 		// READ THE TYPED OBJECTS
 		DataAccessMethod readtyped = new DataAccessMethod("READTYPED", new TwoObjectsArgument("TYPED",
 				new ObjectArgument("MAIN", maintypedobject), new ObjectArgument("COMPANION", this.getParent())), false,
 				false);
 		readtyped.addInputArgument(new MethodArgument("OBJECTID", new ObjectIdArgument("OBJECT", maintypedobject)));
 		this.addDataAccessMethod(readtyped);
 		// UPDATE THE TYPED OBJECT
-		DataAccessMethod updatetyped = new DataAccessMethod("UPDATETYPED",null,false,false);
-		updatetyped.addInputArgument(new MethodArgument("THISCOMPANION",new ObjectArgument("COMPANION",this.getParent())));
-		updatetyped.addInputArgument(new MethodArgument("MAINOBJECT",new ObjectArgument("MAINOBJECT",maintypedobject)));
+		DataAccessMethod updatetyped = new DataAccessMethod("UPDATETYPED", null, false, false);
+		updatetyped.addInputArgument(
+				new MethodArgument("THISCOMPANION", new ObjectArgument("COMPANION", this.getParent())));
+		updatetyped
+				.addInputArgument(new MethodArgument("MAINOBJECT", new ObjectArgument("MAINOBJECT", maintypedobject)));
 
 		this.addDataAccessMethod(updatetyped);
 		// CREATE A TYPED OBJECT
-		DataAccessMethod createtyped = new DataAccessMethod("CREATETYPED",null,false,false);
-		createtyped.addInputArgument(new MethodArgument("THISCOMPANION",new ObjectArgument("COMPANION",this.getParent())));
-		createtyped.addInputArgument(new MethodArgument("MAINOBJECT",new ObjectArgument("MAINOBJECT",maintypedobject)));
-		createtyped.addInputArgument(new MethodArgument("TYPE",new ChoiceArgument("TYPE", mainobjecttypedproperty.getTypes())));
+		DataAccessMethod createtyped = new DataAccessMethod("CREATETYPED", null, false, false);
+		createtyped.addInputArgument(
+				new MethodArgument("THISCOMPANION", new ObjectArgument("COMPANION", this.getParent())));
+		createtyped
+				.addInputArgument(new MethodArgument("MAINOBJECT", new ObjectArgument("MAINOBJECT", maintypedobject)));
+		createtyped.addInputArgument(
+				new MethodArgument("TYPE", new ChoiceArgument("TYPE", mainobjecttypedproperty.getTypes())));
 		this.addDataAccessMethod(createtyped);
-		
+
 		// INSERT AFTER TYPED OBJECT CREATION
-		DataAccessMethod insertcompanion = new DataAccessMethod("INSERTCOMPANION",null,false,false);
-		insertcompanion.addInputArgument(new MethodArgument("THISCOMPANION",new ObjectArgument("COMPANION",this.getParent())));
-		insertcompanion.addInputArgument(new MethodArgument("MAINOBJECT",new ObjectArgument("MAINOBJECT",maintypedobject)));	
+		DataAccessMethod insertcompanion = new DataAccessMethod("INSERTCOMPANION", null, false, false);
+		insertcompanion.addInputArgument(
+				new MethodArgument("THISCOMPANION", new ObjectArgument("COMPANION", this.getParent())));
+		insertcompanion
+				.addInputArgument(new MethodArgument("MAINOBJECT", new ObjectArgument("MAINOBJECT", maintypedobject)));
 		this.addDataAccessMethod(insertcompanion);
-		
-	
-		
+
 		// put the main typed object as related to this property
-		this.addChoiceCategoryHelper("TYPE",((Typed)maintypedobject.getPropertyByName("TYPED")).getTypes() );
-		this.addPropertyGenerics(new PropertyGenerics("MAINTYPEDOBJECT",maintypedobject, maintypedobject.getPropertyByName("TYPED")));
-		this.addDependentProperty(this.getParent().getPropertyByName("HASID"));
+		this.addChoiceCategoryHelper("TYPE", ((Typed) maintypedobject.getPropertyByName("TYPED")).getTypes());
+		this.addPropertyGenerics(
+				new PropertyGenerics("MAINTYPEDOBJECT", maintypedobject, maintypedobject.getPropertyByName("TYPED")));
+		hasid = (HasId) (this.getParent().getPropertyByName("HASID"));
+		this.addDependentProperty(hasid);
 	}
 
 	@Override
@@ -128,10 +141,99 @@ public String getJavaType() {
 
 	@Override
 	public void writeDependentClass(SourceGenerator sg, Module module) throws IOException {
-		SimpleChoiceCategory typechoice = ((Typed)maintypedobject.getPropertyByName("TYPED")).getTypes();
+		SimpleChoiceCategory typechoice = ((Typed) maintypedobject.getPropertyByName("TYPED")).getTypes();
 		sg.wl("import " + typechoice.getParentModule().getPath() + ".data.choice."
 				+ StringFormatter.formatForJavaClass(typechoice.getName()) + "ChoiceDefinition;");
 
 	}
 
+	/**
+	 * @return the list of menus
+	 */
+	public ArrayList<String> getSpecificMenuList() {
+		return hasid.getSpecificMenuList();
+	}
+
+	/**
+	 * get actions assigned on a specific menu
+	 * 
+	 * @param specific menu
+	 * @return actions
+	 */
+	public ArrayList<DynamicActionDefinition> getActionsOnSpecificMenu(String specifictabname) {
+		return hasid.getActionsOnSpecificMenu(specifictabname);
+	}
+
+	/**
+	 * @return the list of actions on object id to be added to button band of the
+	 *         object page
+	 */
+	public NamedList<DynamicActionDefinition> getActionListonObjectId() {
+		return hasid.getActionListonObjectId();
+	}
+
+	/**
+	 * @return the list of actions on object id to be added to the manage menu of
+	 *         the object page
+	 */
+	public NamedList<DynamicActionDefinition> getActionListonObjectIdForManageMenu() {
+		return hasid.getActionListonObjectIdForManageMenu();
+	}
+
+	/**
+	 * @return the list of menu comment to print
+	 */
+	public ArrayList<String> getMenuCommentListOnActionForManageTab() {
+		return hasid.getMenuCommentListOnActionForManageTab();
+	}
+
+	/**
+	 * adds action in the main button band of the object. The action should have a
+	 * single input attribute being the data object id
+	 * 
+	 * @param action adds an action on the object id. The action should have a
+	 *               single input attribute being the data object id
+	 */
+	public void addActionOnObjectId(DynamicActionDefinition action) {
+		addActionOnObjectId(action, false);
+	}
+
+	/**
+	 * adds action in the main button band of the object. The action should have a
+	 * single input attribute being the data object id
+	 * 
+	 * @param action          adds an action on the object id. The action should
+	 *                        have a single input attribute being the data object id
+	 * @param specialmenuname special menu for the action
+	 */
+	public void addActionOnObjectId(DynamicActionDefinition action, String specialmenuname) {
+		hasid.addActionOnObjectId(action, specialmenuname);
+	}
+
+	/**
+	 * adds an action on the object, either in the main button band, or in the
+	 * manage tab
+	 * 
+	 * @param action            adds an action on the object id. The action should
+	 *                          have a single input attribute being the data object
+	 *                          id
+	 * @param actioninmanagetab if true, action is put in manage tabs, if false,
+	 *                          action is directly in the action button
+	 */
+	public void addActionOnObjectId(DynamicActionDefinition action, boolean actioninmanagetab) {
+		hasid.addActionOnObjectId(action, actioninmanagetab);
+	}
+
+	/**
+	 * adds an action on the object, either in the main button band, or in the
+	 * manage tab
+	 * 
+	 * @param action  adds an action on the object id. The action should have a
+	 *                single input attribute being the data object id
+	 * @param comment a comment to add before the content in manage menu
+	 */
+	public void addActionOnObjectIdOnManageMenu(DynamicActionDefinition action, String comment) {
+		hasid.addActionOnObjectIdOnManageMenu(action, comment);
+	}
+
 }

src/org/openlowcode/design/data/properties/basic/Companion.java

@@ -12,7 +12,10 @@
 
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.HashMap;
 
+import org.openlowcode.design.action.DynamicActionDefinition;
+import org.openlowcode.design.data.ArgumentContent;
 import org.openlowcode.design.data.DataAccessMethod;
 import org.openlowcode.design.data.DataObjectDefinition;
 import org.openlowcode.design.data.Index;
@@ -25,6 +28,7 @@
 import org.openlowcode.design.data.argument.ObjectIdArgument;
 import org.openlowcode.design.generation.SourceGenerator;
 import org.openlowcode.design.module.Module;
+import org.openlowcode.tools.misc.NamedList;
 
 /**
  * This property is a split of the original UniqueIdentified property to store
@@ -39,9 +43,19 @@
 public class HasId
 		extends
 		Property<HasId> {
+	private NamedList<DynamicActionDefinition> actionsonobjectid;
+	private NamedList<DynamicActionDefinition> actionsonobjectidonmanagemenu;
+	private ArrayList<String> menucommentinmanagetabs;
+	private HashMap<String, ArrayList<DynamicActionDefinition>> actionsonspecificmenu;
+	private ArrayList<String> specificmenus;
 
 	public HasId() {
 		super("HASID");
+		this.actionsonobjectid = new NamedList<DynamicActionDefinition>();
+		this.actionsonobjectidonmanagemenu = new NamedList<DynamicActionDefinition>();
+		this.menucommentinmanagetabs = new ArrayList<String>();
+		this.actionsonspecificmenu = new HashMap<String, ArrayList<DynamicActionDefinition>>();
+		this.specificmenus = new ArrayList<String>();
 
 	}
 
@@ -50,7 +64,7 @@ public void controlAfterParentDefinition() {
 		StoredElement id = new ObjectIdStoredElement("ID", parent);
 		this.addElement(id, "Id", "technical identification", Property.FIELDDISPLAY_NORMAL, -50, 25);
 		this.addIndex(new Index("ID", id, true));
-		
+
 		DataAccessMethod read = new DataAccessMethod("READONE", new ObjectArgument("OBJECT", parent), false);
 		read.addInputArgument(new MethodArgument("ID", new ObjectIdArgument("ID", parent)));
 		this.addDataAccessMethod(read);
@@ -98,4 +112,130 @@ public String getJavaType() {
 	public void writeDependentClass(SourceGenerator sg, Module module) throws IOException {
 	}
 
+
+	/**
+	 * @return the list of menus
+	 */
+	public ArrayList<String> getSpecificMenuList() {
+		return this.specificmenus;
+	}
+
+	/**
+	 * get actions assigned on a specific menu
+	 * @param specific menu
+	 * @return actions 
+	 */
+	public ArrayList<DynamicActionDefinition> getActionsOnSpecificMenu(String specifictabname) {
+		return this.actionsonspecificmenu.get(specifictabname);
+	}
+
+	/**
+	 * @return the list of actions on object id to be added to button band of the
+	 *         object page
+	 */
+	public NamedList<DynamicActionDefinition> getActionListonObjectId() {
+		return actionsonobjectid;
+	}
+
+	/**
+	 * @return the list of actions on object id to be added to the manage menu of the
+	 *         object page
+	 */
+	public NamedList<DynamicActionDefinition> getActionListonObjectIdForManageMenu() {
+		return actionsonobjectidonmanagemenu;
+	}
+	
+	/**
+	 * @return the list of menu comment to print
+	 */
+	@SuppressWarnings("unchecked")
+	public ArrayList<String> getMenuCommentListOnActionForManageTab() {
+		return (ArrayList<String>)(this.menucommentinmanagetabs.clone());
+	}
+
+	
+	
+	/**
+	 * adds action in the main button band of the object. The action should have a
+	 * single input attribute being the data object id
+	 * 
+	 * @param action adds an action on the object id. The action should have a
+	 *               single input attribute being the data object id
+	 */
+	public void addActionOnObjectId(DynamicActionDefinition action) {
+		addActionOnObjectId(action, false);
+	}
+
+	/**
+	 * adds action in the main button band of the object. The action should have a
+	 * single input attribute being the data object id
+	 * 
+	 * @param action          adds an action on the object id. The action should
+	 *                        have a single input attribute being the data object id
+	 * @param specialmenuname special menu for the action
+	 */
+	public void addActionOnObjectId(DynamicActionDefinition action, String specialmenuname) {
+		validateActionOnObjectId(action);
+		ArrayList<DynamicActionDefinition> actionsforspecialmenu = this.actionsonspecificmenu.get(specialmenuname);
+		if (actionsforspecialmenu == null) {
+			actionsforspecialmenu = new ArrayList<DynamicActionDefinition>();
+			this.actionsonspecificmenu.put(specialmenuname, actionsforspecialmenu);
+			this.specificmenus.add(specialmenuname);
+		}
+		actionsforspecialmenu.add(action);
+	}
+
+	private void validateActionOnObjectId(DynamicActionDefinition action) {
+		if (action.getInputArguments().getSize() != 1)
+			throw new RuntimeException("you can add an action on object id only if it has 1 argument, action "
+					+ action.getName() + " has " + action.getInputArguments().getSize() + ".");
+		ArgumentContent uniqueinputargument = action.getInputArguments().get(0);
+		if (!(uniqueinputargument instanceof ObjectIdArgument))
+			throw new RuntimeException("the first argument of " + action.getName()
+					+ " should be ObjectidArgument, it is actually " + uniqueinputargument.getClass().getName() + ".");
+		ObjectIdArgument objectidargument = (ObjectIdArgument) uniqueinputargument;
+		DataObjectDefinition objectforid = objectidargument.getObject();
+		if (objectforid != parent) {
+			throw new RuntimeException("objectid should be of consistent type, actionid type = "
+					+ objectforid.getOwnermodule().getName() + "/" + objectforid.getName() + ", object parentid type = "
+					+ parent.getOwnermodule().getName() + "/" + parent.getName());
+		}
+	}
+
+	/**
+	 * adds an action on the object, either in the main button band, or in the
+	 * manage tab
+	 * 
+	 * @param action            adds an action on the object id. The action should
+	 *                          have a single input attribute being the data object
+	 *                          id
+	 * @param actioninmanagetab if true, action is put in manage tabs, if false,
+	 *                          action is directly in the action button
+	 */
+	public void addActionOnObjectId(DynamicActionDefinition action, boolean actioninmanagetab) {
+		validateActionOnObjectId(action);
+
+		if (actioninmanagetab) {
+			this.actionsonobjectidonmanagemenu.add(action);
+			this.menucommentinmanagetabs.add(null);
+		} else {
+			actionsonobjectid.add(action);
+
+		}
+	}
+
+	/**
+	 * adds an action on the object, either in the main button band, or in the
+	 * manage tab
+	 * 
+	 * @param action  adds an action on the object id. The action should have a
+	 *                single input attribute being the data object id
+	 * @param comment a comment to add before the content in manage menu
+	 */
+	public void addActionOnObjectIdOnManageMenu(DynamicActionDefinition action, String comment) {
+		this.actionsonobjectidonmanagemenu.add(action);
+		this.menucommentinmanagetabs.add(comment);
+	}
+	
+	
 }