Package org.openbravo.model.ad.module

Class ModuleDependency

java.lang.Object

org.openbravo.base.structure.BaseOBObject

org.openbravo.model.ad.module.ModuleDependency

All Implemented Interfaces:

Serializable, BaseOBObjectDef, OBNotSingleton, OBProvidable, ActiveEnabled, ClientEnabled, DynamicEnabled, Identifiable, OrganizationEnabled, Traceable

public class ModuleDependency
extends BaseOBObject
implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled

Entity class for entity ModuleDependency (stored in table AD_Module_Dependency).
Help: This table defines the dependencies among modules, in case the module is a template the dependencies defined in this table will be used to calculate the modules included in the template.
NOTE: This class should not be instantiated directly. To instantiate this class the OBProvider should be used.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENTITY_NAME
static String	PROPERTY_ACTIVE	Property active stored in column IsActive in table AD_Module_Dependency
static String	PROPERTY_CLIENT	Property client stored in column AD_Client_ID in table AD_Module_Dependency
static String	PROPERTY_CREATEDBY	Property createdBy stored in column CreatedBy in table AD_Module_Dependency
static String	PROPERTY_CREATIONDATE	Property creationDate stored in column Created in table AD_Module_Dependency
static String	PROPERTY_DEPENDANTMODULENAME	Property dependantModuleName stored in column Dependant_Module_Name in table AD_Module_Dependency Help: The name of the dependent module is stored here because the dependent module can have been removed. In that case it is still relevant to show the module name to detect a broken dependency.
static String	PROPERTY_DEPENDENCYENFORCEMENT	Property dependencyEnforcement stored in column Dependency_Enforcement in table AD_Module_Dependency Help: Dependency enforcement defines which are the versions of the dependent module that are compatible with the parent one. The values it can contain are: *Major Version (default). The compatible versions are all the minor version within the same major version. If "Last Version" is defined being a different major version than "From Version", "Last Version" defines the highest compatible minor version; if "Last Version" is in the same major version than "From Version" this value is not taken into account. It is the default value. *Minor Version. Defines a strict dependency to the exact minor version. In case no "Last Version" is set, "From Version" is the only compatible version. Other case the compatible versions are all between "From" and "Last Version" values. *None. "From Version" is the only field taken into account, there is no restriction on different major versions.
static String	PROPERTY_DEPENDENTMODULE	Property dependentModule stored in column AD_Dependent_Module_ID in table AD_Module_Dependency
static String	PROPERTY_FIRSTVERSION	Property firstVersion stored in column StartVersion in table AD_Module_Dependency
static String	PROPERTY_ID	Property id stored in column AD_Module_Dependency_ID in table AD_Module_Dependency
static String	PROPERTY_INSTANCEENFORCEMENT	Property instanceEnforcement stored in column Instance_Enforcement in table AD_Module_Dependency Help: In case the dependency is set as "User Editable", this value overwrites the Instance Enforcement one.
static String	PROPERTY_ISINCLUDED	Property isIncluded stored in column IsIncluded in table AD_Module_Dependency Help: A dependency can include other modules in case it is a dependency for packages.
static String	PROPERTY_LASTVERSION	Property lastVersion stored in column EndVersion in table AD_Module_Dependency Help: It is the last compatible version to define the dependency.
static String	PROPERTY_MODULE	Property module stored in column AD_Module_ID in table AD_Module_Dependency Help: Indicates the module the element forms part of.
static String	PROPERTY_ORGANIZATION	Property organization stored in column AD_Org_ID in table AD_Module_Dependency
static String	PROPERTY_UPDATED	Property updated stored in column Updated in table AD_Module_Dependency
static String	PROPERTY_UPDATEDBY	Property updatedBy stored in column Updatedby in table AD_Module_Dependency
static String	PROPERTY_USEREDITABLEENFORCEMENT	Property userEditableEnforcement stored in column User_Editable_Enforcement in table AD_Module_Dependency Help: When a dependency/inclusion is "User Editable Enforcement", the enforcement defined for that dependency can be overwritten at instance level.
static String	TABLE_NAME

Fields inherited from class org.openbravo.base.structure.BaseOBObject

ID

Constructor Summary

Constructors

Constructor	Description
ModuleDependency()

Method Summary

Modifier and Type	Method	Description
Client	getClient()	Client field
User	getCreatedBy()	Created by audit user
Date	getCreationDate()	Creation date of audit
String	getDependantModuleName()
String	getDependencyEnforcement()
Module	getDependentModule()
String	getEntityName()
String	getFirstVersion()
String	getId()
String	getInstanceEnforcement()
String	getLastVersion()
Module	getModule()
Organization	getOrganization()	Gets organization field
Date	getUpdated()	Update date of audit
User	getUpdatedBy()	Update by audit user
Boolean	isActive()	Gets active field
Boolean	isIncluded()
Boolean	isUserEditableEnforcement()
void	setActive(Boolean active)	Sets active field
void	setClient(Client client)	Client field
void	setCreatedBy(User createdBy)	Created by audit user
void	setCreationDate(Date creationDate)	Creation date of audit
void	setDependantModuleName(String dependantModuleName)
void	setDependencyEnforcement(String dependencyEnforcement)
void	setDependentModule(Module dependentModule)
void	setFirstVersion(String firstVersion)
void	setId(String id)
void	setIncluded(Boolean isIncluded)
void	setInstanceEnforcement(String instanceEnforcement)
void	setLastVersion(String lastVersion)
void	setModule(Module module)
void	setOrganization(Organization organization)	Sets organization field
void	setUpdated(Date updated)	Update date of audit
void	setUpdatedBy(User updatedBy)	Update by audit user
void	setUserEditableEnforcement(Boolean userEditableEnforcement)

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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_Module_Dependency_ID in table AD_Module_Dependency

See Also:

Constant Field Values

PROPERTY_CLIENT

public static final String PROPERTY_CLIENT

Property client stored in column AD_Client_ID in table AD_Module_Dependency

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_Module_Dependency

See Also:

OrganizationEnabled, Constant Field Values

PROPERTY_ACTIVE

public static final String PROPERTY_ACTIVE

Property active stored in column IsActive in table AD_Module_Dependency

See Also:

ActiveEnabled, Constant Field Values

PROPERTY_CREATIONDATE

public static final String PROPERTY_CREATIONDATE

Property creationDate stored in column Created in table AD_Module_Dependency

See Also:

Traceable, Constant Field Values

PROPERTY_CREATEDBY

public static final String PROPERTY_CREATEDBY

Property createdBy stored in column CreatedBy in table AD_Module_Dependency

See Also:

Traceable, Constant Field Values

PROPERTY_UPDATED

public static final String PROPERTY_UPDATED

Property updated stored in column Updated in table AD_Module_Dependency

See Also:

Traceable, Constant Field Values

PROPERTY_UPDATEDBY

public static final String PROPERTY_UPDATEDBY

Property updatedBy stored in column Updatedby in table AD_Module_Dependency

See Also:

Traceable, Constant Field Values

PROPERTY_MODULE

public static final String PROPERTY_MODULE

Property module stored in column AD_Module_ID in table AD_Module_Dependency
Help: Indicates the module the element forms part of.

See Also:

Constant Field Values

PROPERTY_DEPENDENTMODULE

public static final String PROPERTY_DEPENDENTMODULE

Property dependentModule stored in column AD_Dependent_Module_ID in table AD_Module_Dependency

See Also:

Constant Field Values

PROPERTY_FIRSTVERSION

public static final String PROPERTY_FIRSTVERSION

Property firstVersion stored in column StartVersion in table AD_Module_Dependency

See Also:

Constant Field Values

PROPERTY_LASTVERSION

public static final String PROPERTY_LASTVERSION

Property lastVersion stored in column EndVersion in table AD_Module_Dependency
Help: It is the last compatible version to define the dependency.

See Also:

Constant Field Values

PROPERTY_ISINCLUDED

public static final String PROPERTY_ISINCLUDED

Property isIncluded stored in column IsIncluded in table AD_Module_Dependency
Help: A dependency can include other modules in case it is a dependency for packages.

See Also:

Constant Field Values

PROPERTY_DEPENDANTMODULENAME

public static final String PROPERTY_DEPENDANTMODULENAME

Property dependantModuleName stored in column Dependant_Module_Name in table AD_Module_Dependency
Help: The name of the dependent module is stored here because the dependent module can have been removed. In that case it is still relevant to show the module name to detect a broken dependency.

See Also:

Constant Field Values

PROPERTY_DEPENDENCYENFORCEMENT

public static final String PROPERTY_DEPENDENCYENFORCEMENT

Property dependencyEnforcement stored in column Dependency_Enforcement in table AD_Module_Dependency
Help: Dependency enforcement defines which are the versions of the dependent module that are compatible with the parent one. The values it can contain are: *Major Version (default). The compatible versions are all the minor version within the same major version. If "Last Version" is defined being a different major version than "From Version", "Last Version" defines the highest compatible minor version; if "Last Version" is in the same major version than "From Version" this value is not taken into account. It is the default value. *Minor Version. Defines a strict dependency to the exact minor version. In case no "Last Version" is set, "From Version" is the only compatible version. Other case the compatible versions are all between "From" and "Last Version" values. *None. "From Version" is the only field taken into account, there is no restriction on different major versions.

See Also:

Constant Field Values

PROPERTY_USEREDITABLEENFORCEMENT

public static final String PROPERTY_USEREDITABLEENFORCEMENT

Property userEditableEnforcement stored in column User_Editable_Enforcement in table AD_Module_Dependency
Help: When a dependency/inclusion is "User Editable Enforcement", the enforcement defined for that dependency can be overwritten at instance level.

See Also:

Constant Field Values

PROPERTY_INSTANCEENFORCEMENT

public static final String PROPERTY_INSTANCEENFORCEMENT

Property instanceEnforcement stored in column Instance_Enforcement in table AD_Module_Dependency
Help: In case the dependency is set as "User Editable", this value overwrites the Instance Enforcement one.

See Also:

Constant Field Values

Constructor Detail

ModuleDependency

public ModuleDependency()

Method Detail

getEntityName

public String getEntityName()

Specified by:

getEntityName in interface Identifiable

Specified by:

getEntityName in class BaseOBObject

getId

public String getId()

Specified by:

getId in interface BaseOBObjectDef

Specified by:

getId in interface Identifiable

Overrides:

getId in class BaseOBObject

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 interface ClientEnabled

Returns:

client

See Also:

PROPERTY_CLIENT

setClient

public void setClient(Client client)

Description copied from interface: ClientEnabled

Client field

Specified by:

setClient in interface ClientEnabled

See Also:

PROPERTY_CLIENT

getOrganization

public Organization getOrganization()

Description copied from interface: OrganizationEnabled

Gets organization field

Specified by:

getOrganization in interface OrganizationEnabled

Returns:

organization

See Also:

PROPERTY_ORGANIZATION

setOrganization

public void setOrganization(Organization organization)

Description copied from interface: OrganizationEnabled

Sets organization field

Specified by:

setOrganization in interface OrganizationEnabled

See Also:

PROPERTY_ORGANIZATION

isActive

public Boolean isActive()

Description copied from interface: ActiveEnabled

Gets active field

Specified by:

isActive in interface ActiveEnabled

Returns:

active

See Also:

PROPERTY_ACTIVE

setActive

public void setActive(Boolean active)

Description copied from interface: ActiveEnabled

Sets active field

Specified by:

setActive in interface ActiveEnabled

See Also:

PROPERTY_ACTIVE

getCreationDate

public Date getCreationDate()

Description copied from interface: Traceable

Creation date of audit

Specified by:

getCreationDate in interface Traceable

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 interface Traceable

See Also:

PROPERTY_CREATIONDATE

getCreatedBy

public User getCreatedBy()

Description copied from interface: Traceable

Created by audit user

Specified by:

getCreatedBy in interface Traceable

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 interface Traceable

See Also:

PROPERTY_CREATEDBY

getUpdated

public Date getUpdated()

Description copied from interface: Traceable

Update date of audit

Specified by:

getUpdated in interface Traceable

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 interface Traceable

See Also:

PROPERTY_UPDATED

getUpdatedBy

public User getUpdatedBy()

Description copied from interface: Traceable

Update by audit user

Specified by:

getUpdatedBy in interface Traceable

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 interface Traceable

See Also:

PROPERTY_UPDATEDBY

getModule

public Module getModule()

See Also:

PROPERTY_MODULE

setModule

public void setModule(Module module)

See Also:

PROPERTY_MODULE

getDependentModule

public Module getDependentModule()

See Also:

PROPERTY_DEPENDENTMODULE

setDependentModule

public void setDependentModule(Module dependentModule)

See Also:

PROPERTY_DEPENDENTMODULE

getFirstVersion

public String getFirstVersion()

See Also:

PROPERTY_FIRSTVERSION

setFirstVersion

public void setFirstVersion(String firstVersion)

See Also:

PROPERTY_FIRSTVERSION

getLastVersion

public String getLastVersion()

See Also:

PROPERTY_LASTVERSION

setLastVersion

public void setLastVersion(String lastVersion)

See Also:

PROPERTY_LASTVERSION

isIncluded

public Boolean isIncluded()

See Also:

PROPERTY_ISINCLUDED

setIncluded

public void setIncluded(Boolean isIncluded)

See Also:

PROPERTY_ISINCLUDED

getDependantModuleName

public String getDependantModuleName()

See Also:

PROPERTY_DEPENDANTMODULENAME

setDependantModuleName

public void setDependantModuleName(String dependantModuleName)

See Also:

PROPERTY_DEPENDANTMODULENAME

getDependencyEnforcement

public String getDependencyEnforcement()

See Also:

PROPERTY_DEPENDENCYENFORCEMENT

setDependencyEnforcement

public void setDependencyEnforcement(String dependencyEnforcement)

See Also:

PROPERTY_DEPENDENCYENFORCEMENT

isUserEditableEnforcement

public Boolean isUserEditableEnforcement()

See Also:

PROPERTY_USEREDITABLEENFORCEMENT

setUserEditableEnforcement

public void setUserEditableEnforcement(Boolean userEditableEnforcement)

See Also:

PROPERTY_USEREDITABLEENFORCEMENT

getInstanceEnforcement

public String getInstanceEnforcement()

See Also:

PROPERTY_INSTANCEENFORCEMENT

setInstanceEnforcement

public void setInstanceEnforcement(String instanceEnforcement)

See Also:

PROPERTY_INSTANCEENFORCEMENT