Package org.openbravo.model.ad.ui
Class Menu
- java.lang.Object
-
- org.openbravo.base.structure.BaseOBObject
-
- org.openbravo.model.ad.ui.Menu
-
- All Implemented Interfaces:
Serializable
,BaseOBObjectDef
,OBNotSingleton
,OBProvidable
,ActiveEnabled
,ClientEnabled
,DynamicEnabled
,Identifiable
,OrganizationEnabled
,Traceable
public class Menu extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled
Entity class for entity ADMenu (stored in table AD_Menu).
Help: The Menu Tab defines the tree structured menu which will be used for the selected Organization.
NOTE: This class should not be instantiated directly. To instantiate this class theOBProvider
should be used.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
ENTITY_NAME
static String
PROPERTY_ACTION
Property action stored in column Action in table AD_Menu
Help: The Action field indicates the Action to be performed for this element.static String
PROPERTY_ACTIVE
Property active stored in column IsActive in table AD_Menustatic String
PROPERTY_ADMENUTRLLIST
Property aDMenuTrlList stored in table AD_Menustatic String
PROPERTY_CLIENT
Property client stored in column AD_Client_ID in table AD_Menustatic String
PROPERTY_CREATEDBY
Property createdBy stored in column CreatedBy in table AD_Menustatic String
PROPERTY_CREATIONDATE
Property creationDate stored in column Created in table AD_Menustatic String
PROPERTY_DESCRIPTION
Property description stored in column Description in table AD_Menu
Help: A description is limited to 255 characters.static String
PROPERTY_ID
Property id stored in column AD_Menu_ID in table AD_Menu
Help: The Menu identifies a unique Menu. Menus are used to control the display of those screens a user has access to.static String
PROPERTY_MODULE
Property module stored in column AD_Module_ID in table AD_Menu
Help: Indicates the module the element forms part of.static String
PROPERTY_NAME
Property name stored in column Name in table AD_Menustatic String
PROPERTY_OBUIAPPMENUPARAMETERSLIST
Property oBUIAPPMenuParametersList stored in table AD_Menustatic String
PROPERTY_OBUIAPPPROCESSDEFINITION
Property oBUIAPPProcessDefinition stored in column EM_Obuiapp_Process_ID in table AD_Menu
Help: Process to be executed by the button. There are 2 kinds of processes: *"Process": Implements the 2.50 style processes with a Servlet. *"Process Definition": Implements 3.0 processes with a pure SmartClient UI.static String
PROPERTY_OBUIAPPVIEW
Property obuiappView stored in column EM_OBUIAPP_VIEW_IMPL_ID in table AD_Menu
Help: The view implementation which is shown in the tab of a multi-document-interface.static String
PROPERTY_OPENLINKINBROWSER
Property openlinkinbrowser stored in column Openlinkinbrowser in table AD_Menu
Help: A flag to indicate if the link has to be opened in a browser's tab.static String
PROPERTY_ORGANIZATION
Property organization stored in column AD_Org_ID in table AD_Menustatic String
PROPERTY_PROCESS
Property process stored in column AD_Process_ID in table AD_Menu
Help: The Process field identifies a unique Process or Report in the system.static String
PROPERTY_SPECIALFORM
Property specialForm stored in column AD_Form_ID in table AD_Menu
Help: The Special Form field identifies a unique Special Form in the system.static String
PROPERTY_SUMMARYLEVEL
Property summaryLevel stored in column IsSummary in table AD_Menu
Help: A summary entity represents a branch in a tree rather than an end-node. Summary entities are used for reporting and do not have own values.static String
PROPERTY_TRANSLATIONSTRATEGY
Property translationStrategy stored in column Translation_Strategy in table AD_Menu
Help: When exporting the translation it is possible to export the full translation or to export a reduced version. If the value is set as Exclude From Reduced Translation, all the windows, processes, etc related to the functionality that is linked to this Menu entry will not be proposed into the reduced translation.static String
PROPERTY_UPDATED
Property updated stored in column Updated in table AD_Menustatic String
PROPERTY_UPDATEDBY
Property updatedBy stored in column UpdatedBy in table AD_Menustatic String
PROPERTY_URL
Property uRL stored in column URL in table AD_Menu
Help: The URL defines an online address for this element.static String
PROPERTY_WINDOW
Property window stored in column AD_Window_ID in table AD_Menu
Help: The Window field identifies a unique Window in the system.static String
TABLE_NAME
-
Fields inherited from class org.openbravo.base.structure.BaseOBObject
ID
-
-
Constructor Summary
Constructors Constructor Description Menu()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getAction()
List<MenuTrl>
getADMenuTrlList()
Help: Menu translations are derived from Window, Process, etc. You only need to translate Summary level items. Run Synchronize Terminology to update menu translation.Client
getClient()
Client fieldUser
getCreatedBy()
Created by audit userDate
getCreationDate()
Creation date of auditString
getDescription()
String
getEntityName()
String
getId()
Module
getModule()
String
getName()
List<MenuParameter>
getOBUIAPPMenuParametersList()
Help: Menu parameters passed in when a view is instantiated.Process
getOBUIAPPProcessDefinition()
OBUIAPPViewImplementation
getObuiappView()
Organization
getOrganization()
Gets organization fieldProcess
getProcess()
Form
getSpecialForm()
String
getTranslationStrategy()
Date
getUpdated()
Update date of auditUser
getUpdatedBy()
Update by audit userString
getURL()
Window
getWindow()
Boolean
isActive()
Gets active fieldBoolean
isOpenlinkinbrowser()
Boolean
isSummaryLevel()
void
setAction(String action)
void
setActive(Boolean active)
Sets active fieldvoid
setADMenuTrlList(List<MenuTrl> aDMenuTrlList)
Help: Menu translations are derived from Window, Process, etc. You only need to translate Summary level items. Run Synchronize Terminology to update menu translation.void
setClient(Client client)
Client fieldvoid
setCreatedBy(User createdBy)
Created by audit uservoid
setCreationDate(Date creationDate)
Creation date of auditvoid
setDescription(String description)
void
setId(String id)
void
setModule(Module module)
void
setName(String name)
void
setOBUIAPPMenuParametersList(List<MenuParameter> oBUIAPPMenuParametersList)
Help: Menu parameters passed in when a view is instantiated.void
setOBUIAPPProcessDefinition(Process oBUIAPPProcessDefinition)
void
setObuiappView(OBUIAPPViewImplementation obuiappView)
void
setOpenlinkinbrowser(Boolean openlinkinbrowser)
void
setOrganization(Organization organization)
Sets organization fieldvoid
setProcess(Process process)
void
setSpecialForm(Form specialForm)
void
setSummaryLevel(Boolean summaryLevel)
void
setTranslationStrategy(String translationStrategy)
void
setUpdated(Date updated)
Update date of auditvoid
setUpdatedBy(User updatedBy)
Update by audit uservoid
setURL(String uRL)
void
setWindow(Window window)
-
Methods inherited from class org.openbravo.base.structure.BaseOBObject
checkDerivedReadable, get, get, get, getEntity, getIdentifier, getValue, isAllowRead, isNewOBObject, isOrgClientAccessCheckEnabled, isWriteAccessCheckEnabled, set, setAccessChecks, setAllowRead, setDefaultValue, setId, setNewOBObject, setValue, toString, validate
-
-
-
-
Field Detail
-
TABLE_NAME
public static final String TABLE_NAME
- See Also:
- Constant Field Values
-
ENTITY_NAME
public static final String ENTITY_NAME
- See Also:
- Constant Field Values
-
PROPERTY_ID
public static final String PROPERTY_ID
Property id stored in column AD_Menu_ID in table AD_Menu
Help: The Menu identifies a unique Menu. Menus are used to control the display of those screens a user has access to.- See Also:
- Constant Field Values
-
PROPERTY_CLIENT
public static final String PROPERTY_CLIENT
Property client stored in column AD_Client_ID in table AD_Menu- See Also:
ClientEnabled
, Constant Field Values
-
PROPERTY_ORGANIZATION
public static final String PROPERTY_ORGANIZATION
Property organization stored in column AD_Org_ID in table AD_Menu- See Also:
OrganizationEnabled
, Constant Field Values
-
PROPERTY_ACTIVE
public static final String PROPERTY_ACTIVE
Property active stored in column IsActive in table AD_Menu- See Also:
ActiveEnabled
, Constant Field Values
-
PROPERTY_CREATIONDATE
public static final String PROPERTY_CREATIONDATE
Property creationDate stored in column Created in table AD_Menu- See Also:
Traceable
, Constant Field Values
-
PROPERTY_CREATEDBY
public static final String PROPERTY_CREATEDBY
Property createdBy stored in column CreatedBy in table AD_Menu- See Also:
Traceable
, Constant Field Values
-
PROPERTY_UPDATED
public static final String PROPERTY_UPDATED
Property updated stored in column Updated in table AD_Menu- See Also:
Traceable
, Constant Field Values
-
PROPERTY_NAME
public static final String PROPERTY_NAME
Property name stored in column Name in table AD_Menu- See Also:
- Constant Field Values
-
PROPERTY_UPDATEDBY
public static final String PROPERTY_UPDATEDBY
Property updatedBy stored in column UpdatedBy in table AD_Menu- See Also:
Traceable
, Constant Field Values
-
PROPERTY_DESCRIPTION
public static final String PROPERTY_DESCRIPTION
Property description stored in column Description in table AD_Menu
Help: A description is limited to 255 characters.- See Also:
- Constant Field Values
-
PROPERTY_SUMMARYLEVEL
public static final String PROPERTY_SUMMARYLEVEL
Property summaryLevel stored in column IsSummary in table AD_Menu
Help: A summary entity represents a branch in a tree rather than an end-node. Summary entities are used for reporting and do not have own values.- See Also:
- Constant Field Values
-
PROPERTY_ACTION
public static final String PROPERTY_ACTION
Property action stored in column Action in table AD_Menu
Help: The Action field indicates the Action to be performed for this element.- See Also:
- Constant Field Values
-
PROPERTY_WINDOW
public static final String PROPERTY_WINDOW
Property window stored in column AD_Window_ID in table AD_Menu
Help: The Window field identifies a unique Window in the system.- See Also:
- Constant Field Values
-
PROPERTY_PROCESS
public static final String PROPERTY_PROCESS
Property process stored in column AD_Process_ID in table AD_Menu
Help: The Process field identifies a unique Process or Report in the system.- See Also:
- Constant Field Values
-
PROPERTY_SPECIALFORM
public static final String PROPERTY_SPECIALFORM
Property specialForm stored in column AD_Form_ID in table AD_Menu
Help: The Special Form field identifies a unique Special Form in the system.- See Also:
- Constant Field Values
-
PROPERTY_URL
public static final String PROPERTY_URL
Property uRL stored in column URL in table AD_Menu
Help: The URL defines an online address for this element.- See Also:
- Constant Field Values
-
PROPERTY_MODULE
public static final String PROPERTY_MODULE
Property module stored in column AD_Module_ID in table AD_Menu
Help: Indicates the module the element forms part of.- See Also:
- Constant Field Values
-
PROPERTY_OBUIAPPVIEW
public static final String PROPERTY_OBUIAPPVIEW
Property obuiappView stored in column EM_OBUIAPP_VIEW_IMPL_ID in table AD_Menu
Help: The view implementation which is shown in the tab of a multi-document-interface.- See Also:
- Constant Field Values
-
PROPERTY_OPENLINKINBROWSER
public static final String PROPERTY_OPENLINKINBROWSER
Property openlinkinbrowser stored in column Openlinkinbrowser in table AD_Menu
Help: A flag to indicate if the link has to be opened in a browser's tab.- See Also:
- Constant Field Values
-
PROPERTY_OBUIAPPPROCESSDEFINITION
public static final String PROPERTY_OBUIAPPPROCESSDEFINITION
Property oBUIAPPProcessDefinition stored in column EM_Obuiapp_Process_ID in table AD_Menu
Help: Process to be executed by the button. There are 2 kinds of processes: *"Process": Implements the 2.50 style processes with a Servlet. *"Process Definition": Implements 3.0 processes with a pure SmartClient UI.- See Also:
- Constant Field Values
-
PROPERTY_TRANSLATIONSTRATEGY
public static final String PROPERTY_TRANSLATIONSTRATEGY
Property translationStrategy stored in column Translation_Strategy in table AD_Menu
Help: When exporting the translation it is possible to export the full translation or to export a reduced version. If the value is set as Exclude From Reduced Translation, all the windows, processes, etc related to the functionality that is linked to this Menu entry will not be proposed into the reduced translation.- See Also:
- Constant Field Values
-
PROPERTY_ADMENUTRLLIST
public static final String PROPERTY_ADMENUTRLLIST
Property aDMenuTrlList stored in table AD_Menu- See Also:
- Constant Field Values
-
PROPERTY_OBUIAPPMENUPARAMETERSLIST
public static final String PROPERTY_OBUIAPPMENUPARAMETERSLIST
Property oBUIAPPMenuParametersList stored in table AD_Menu- See Also:
- Constant Field Values
-
-
Method Detail
-
getEntityName
public String getEntityName()
- Specified by:
getEntityName
in interfaceIdentifiable
- Specified by:
getEntityName
in classBaseOBObject
-
getId
public String getId()
- Specified by:
getId
in interfaceBaseOBObjectDef
- Specified by:
getId
in interfaceIdentifiable
- Overrides:
getId
in classBaseOBObject
- See Also:
PROPERTY_ID
-
setId
public void setId(String id)
- See Also:
PROPERTY_ID
-
getClient
public Client getClient()
Description copied from interface:ClientEnabled
Client field- Specified by:
getClient
in interfaceClientEnabled
- Returns:
- client
- See Also:
PROPERTY_CLIENT
-
setClient
public void setClient(Client client)
Description copied from interface:ClientEnabled
Client field- Specified by:
setClient
in interfaceClientEnabled
- See Also:
PROPERTY_CLIENT
-
getOrganization
public Organization getOrganization()
Description copied from interface:OrganizationEnabled
Gets organization field- Specified by:
getOrganization
in interfaceOrganizationEnabled
- Returns:
- organization
- See Also:
PROPERTY_ORGANIZATION
-
setOrganization
public void setOrganization(Organization organization)
Description copied from interface:OrganizationEnabled
Sets organization field- Specified by:
setOrganization
in interfaceOrganizationEnabled
- See Also:
PROPERTY_ORGANIZATION
-
isActive
public Boolean isActive()
Description copied from interface:ActiveEnabled
Gets active field- Specified by:
isActive
in interfaceActiveEnabled
- Returns:
- active
- See Also:
PROPERTY_ACTIVE
-
setActive
public void setActive(Boolean active)
Description copied from interface:ActiveEnabled
Sets active field- Specified by:
setActive
in interfaceActiveEnabled
- See Also:
PROPERTY_ACTIVE
-
getCreationDate
public Date getCreationDate()
Description copied from interface:Traceable
Creation date of audit- Specified by:
getCreationDate
in interfaceTraceable
- Returns:
- Date of creation
- See Also:
PROPERTY_CREATIONDATE
-
setCreationDate
public void setCreationDate(Date creationDate)
Description copied from interface:Traceable
Creation date of audit- Specified by:
setCreationDate
in interfaceTraceable
- See Also:
PROPERTY_CREATIONDATE
-
getCreatedBy
public User getCreatedBy()
Description copied from interface:Traceable
Created by audit user- Specified by:
getCreatedBy
in interfaceTraceable
- Returns:
- User
- See Also:
PROPERTY_CREATEDBY
-
setCreatedBy
public void setCreatedBy(User createdBy)
Description copied from interface:Traceable
Created by audit user- Specified by:
setCreatedBy
in interfaceTraceable
- See Also:
PROPERTY_CREATEDBY
-
getUpdated
public Date getUpdated()
Description copied from interface:Traceable
Update date of audit- Specified by:
getUpdated
in interfaceTraceable
- Returns:
- Date of update
- See Also:
PROPERTY_UPDATED
-
setUpdated
public void setUpdated(Date updated)
Description copied from interface:Traceable
Update date of audit- Specified by:
setUpdated
in interfaceTraceable
- See Also:
PROPERTY_UPDATED
-
getName
public String getName()
- See Also:
PROPERTY_NAME
-
setName
public void setName(String name)
- See Also:
PROPERTY_NAME
-
getUpdatedBy
public User getUpdatedBy()
Description copied from interface:Traceable
Update by audit user- Specified by:
getUpdatedBy
in interfaceTraceable
- Returns:
- User who updated
- See Also:
PROPERTY_UPDATEDBY
-
setUpdatedBy
public void setUpdatedBy(User updatedBy)
Description copied from interface:Traceable
Update by audit user- Specified by:
setUpdatedBy
in interfaceTraceable
- See Also:
PROPERTY_UPDATEDBY
-
getDescription
public String getDescription()
- See Also:
PROPERTY_DESCRIPTION
-
setDescription
public void setDescription(String description)
- See Also:
PROPERTY_DESCRIPTION
-
isSummaryLevel
public Boolean isSummaryLevel()
- See Also:
PROPERTY_SUMMARYLEVEL
-
setSummaryLevel
public void setSummaryLevel(Boolean summaryLevel)
- See Also:
PROPERTY_SUMMARYLEVEL
-
getAction
public String getAction()
- See Also:
PROPERTY_ACTION
-
setAction
public void setAction(String action)
- See Also:
PROPERTY_ACTION
-
getWindow
public Window getWindow()
- See Also:
PROPERTY_WINDOW
-
setWindow
public void setWindow(Window window)
- See Also:
PROPERTY_WINDOW
-
getProcess
public Process getProcess()
- See Also:
PROPERTY_PROCESS
-
setProcess
public void setProcess(Process process)
- See Also:
PROPERTY_PROCESS
-
getSpecialForm
public Form getSpecialForm()
- See Also:
PROPERTY_SPECIALFORM
-
setSpecialForm
public void setSpecialForm(Form specialForm)
- See Also:
PROPERTY_SPECIALFORM
-
getURL
public String getURL()
- See Also:
PROPERTY_URL
-
setURL
public void setURL(String uRL)
- See Also:
PROPERTY_URL
-
getModule
public Module getModule()
- See Also:
PROPERTY_MODULE
-
setModule
public void setModule(Module module)
- See Also:
PROPERTY_MODULE
-
getObuiappView
public OBUIAPPViewImplementation getObuiappView()
- See Also:
PROPERTY_OBUIAPPVIEW
-
setObuiappView
public void setObuiappView(OBUIAPPViewImplementation obuiappView)
- See Also:
PROPERTY_OBUIAPPVIEW
-
isOpenlinkinbrowser
public Boolean isOpenlinkinbrowser()
- See Also:
PROPERTY_OPENLINKINBROWSER
-
setOpenlinkinbrowser
public void setOpenlinkinbrowser(Boolean openlinkinbrowser)
- See Also:
PROPERTY_OPENLINKINBROWSER
-
getOBUIAPPProcessDefinition
public Process getOBUIAPPProcessDefinition()
- See Also:
PROPERTY_OBUIAPPPROCESSDEFINITION
-
setOBUIAPPProcessDefinition
public void setOBUIAPPProcessDefinition(Process oBUIAPPProcessDefinition)
- See Also:
PROPERTY_OBUIAPPPROCESSDEFINITION
-
getTranslationStrategy
public String getTranslationStrategy()
- See Also:
PROPERTY_TRANSLATIONSTRATEGY
-
setTranslationStrategy
public void setTranslationStrategy(String translationStrategy)
- See Also:
PROPERTY_TRANSLATIONSTRATEGY
-
getADMenuTrlList
public List<MenuTrl> getADMenuTrlList()
Help: Menu translations are derived from Window, Process, etc. You only need to translate Summary level items. Run Synchronize Terminology to update menu translation.- See Also:
MenuTrl
-
setADMenuTrlList
public void setADMenuTrlList(List<MenuTrl> aDMenuTrlList)
Help: Menu translations are derived from Window, Process, etc. You only need to translate Summary level items. Run Synchronize Terminology to update menu translation.- See Also:
MenuTrl
-
getOBUIAPPMenuParametersList
public List<MenuParameter> getOBUIAPPMenuParametersList()
Help: Menu parameters passed in when a view is instantiated.- See Also:
MenuParameter
-
setOBUIAPPMenuParametersList
public void setOBUIAPPMenuParametersList(List<MenuParameter> oBUIAPPMenuParametersList)
Help: Menu parameters passed in when a view is instantiated.- See Also:
MenuParameter
-
-