Package org.openbravo.model.ad.utility
Class DataSet
- java.lang.Object
-
- org.openbravo.base.structure.BaseOBObject
-
- org.openbravo.model.ad.utility.DataSet
-
- All Implemented Interfaces:
Serializable
,BaseOBObjectDef
,OBNotSingleton
,OBProvidable
,ActiveEnabled
,ClientEnabled
,DynamicEnabled
,Identifiable
,OrganizationEnabled
,Traceable
public class DataSet extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled
Entity class for entity DataSet (stored in table AD_Dataset).
Help: Sets of data.
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_ACTIVE
Property active stored in column IsActive in table AD_Datasetstatic String
PROPERTY_CHECKSUM
Property checksum stored in column Checksum in table AD_Dataset
Help: The checksum information is used to verify whether the version of the dataset which was imported in the database is up to date, or needs to be updated.static String
PROPERTY_CLIENT
Property client stored in column AD_Client_ID in table AD_Datasetstatic String
PROPERTY_CREATEDBY
Property createdBy stored in column CreatedBy in table AD_Datasetstatic String
PROPERTY_CREATIONDATE
Property creationDate stored in column Created in table AD_Datasetstatic String
PROPERTY_DATAACCESSLEVEL
Property dataAccessLevel stored in column Accesslevel in table AD_Dataset
Help: Indicates what type of data (in terms of AD_CLIENT and AD_ORG data columns) can be entered or viewed. We can classify data in 4 major categories: - System (AD_CLIENT_ID=0, AD_ORG_ID=0) - system data (such as metadata for window, tab and field definition) - Organization (AD_CLIENT<>0, AD_ORG_ID<>0) - data particular to an organization (such as sales orders) - Client/Organization (AD_CLIENT<>0, AD_ORG_ID=anything) - data particular to an organization or shared among all organizations within one client - Client (AD_CLIENT<>0, AD_ORG_ID=0) - data that is specific to a client but can be used by all organizations within that client or All (AD_CLIENT=anything, AD_ORG_ID=anything)static String
PROPERTY_DATASETTABLELIST
Property dataSetTableList stored in table AD_Datasetstatic String
PROPERTY_DEFAULTVALUESDATASET
Property defaultValuesDataSet stored in column IsDefaultValuesDataSet in table AD_Dataset
Help: Data sets marked as "Default Values Data Set" import data as default values. The owner of this data once imported is not the data set anymore but the instance. This means that subsequent data set updates will not modify this data, though they can add new rows, preserving any change performed in the instance where they were initially imported.static String
PROPERTY_DESCRIPTION
Property description stored in column Description in table AD_Dataset
Help: A description is limited to 255 characters.static String
PROPERTY_EXPORT
Property export stored in column Export in table AD_Dataset
Help: Export Reference Data to a XML filestatic String
PROPERTY_EXPORTALLOWED
Property exportAllowed stored in column ExportAllowed in table AD_Dataset
Help: This data set can be exported. There are datasets which are not meant to be exported, such as the AD dataset (which contains the set of tables which define the Application Dictionary), or the Client dataset. If the dataset needs to be exported via the Export Dataset functionality, this check should be marked. If it's going to be used for another purpose, and its data content doesn't need to be included inside the modules, then it should be unchecked.static String
PROPERTY_ID
Property id stored in column AD_Dataset_ID in table AD_Dataset
Help: Indicates the dataset the element forms part of.static String
PROPERTY_MODULE
Property module stored in column AD_Module_ID in table AD_Dataset
Help: Indicates the module the element forms part of.static String
PROPERTY_NAME
Property name stored in column Name in table AD_Datasetstatic String
PROPERTY_ORGANIZATION
Property organization stored in column AD_Org_ID in table AD_Datasetstatic String
PROPERTY_SEARCHKEY
Property searchKey stored in column Value in table AD_Dataset
Help: A search key allows for a fast method of finding a particular record. If you leave the search key empty, the system automatically creates a numeric number originating from a document sequence defined in the "Document Sequence" window. The sequence naming convention follows a rule "DocumentNo_TableName", where TableName is the actual name of the database table (e.g. C_Order). Usually, company's internal identifiers for various records (products, customers, etc) are stored here.static String
PROPERTY_SEQUENCENUMBER
Property sequenceNumber stored in column Seqno in table AD_Dataset
Help: The Sequence indicates the order of recordsstatic String
PROPERTY_UPDATED
Property updated stored in column Updated in table AD_Datasetstatic String
PROPERTY_UPDATEDBY
Property updatedBy stored in column UpdatedBy in table AD_Datasetstatic String
TABLE_NAME
-
Fields inherited from class org.openbravo.base.structure.BaseOBObject
ID
-
-
Constructor Summary
Constructors Constructor Description DataSet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getChecksum()
Client
getClient()
Client fieldUser
getCreatedBy()
Created by audit userDate
getCreationDate()
Creation date of auditString
getDataAccessLevel()
List<DataSetTable>
getDataSetTableList()
Help: Tables of a Dataset.String
getDescription()
String
getEntityName()
String
getId()
Module
getModule()
String
getName()
Organization
getOrganization()
Gets organization fieldString
getSearchKey()
Long
getSequenceNumber()
Date
getUpdated()
Update date of auditUser
getUpdatedBy()
Update by audit userBoolean
isActive()
Gets active fieldBoolean
isDefaultValuesDataSet()
Boolean
isExport()
Boolean
isExportAllowed()
void
setActive(Boolean active)
Sets active fieldvoid
setChecksum(String checksum)
void
setClient(Client client)
Client fieldvoid
setCreatedBy(User createdBy)
Created by audit uservoid
setCreationDate(Date creationDate)
Creation date of auditvoid
setDataAccessLevel(String dataAccessLevel)
void
setDataSetTableList(List<DataSetTable> dataSetTableList)
Help: Tables of a Dataset.void
setDefaultValuesDataSet(Boolean defaultValuesDataSet)
void
setDescription(String description)
void
setExport(Boolean export)
void
setExportAllowed(Boolean exportAllowed)
void
setId(String id)
void
setModule(Module module)
void
setName(String name)
void
setOrganization(Organization organization)
Sets organization fieldvoid
setSearchKey(String searchKey)
void
setSequenceNumber(Long sequenceNumber)
void
setUpdated(Date updated)
Update date of auditvoid
setUpdatedBy(User updatedBy)
Update by audit user-
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_Dataset_ID in table AD_Dataset
Help: Indicates the dataset the element forms part of.- See Also:
- Constant Field Values
-
PROPERTY_CLIENT
public static final String PROPERTY_CLIENT
Property client stored in column AD_Client_ID in table AD_Dataset- 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_Dataset- See Also:
OrganizationEnabled
, Constant Field Values
-
PROPERTY_ACTIVE
public static final String PROPERTY_ACTIVE
Property active stored in column IsActive in table AD_Dataset- See Also:
ActiveEnabled
, Constant Field Values
-
PROPERTY_CREATIONDATE
public static final String PROPERTY_CREATIONDATE
Property creationDate stored in column Created in table AD_Dataset- See Also:
Traceable
, Constant Field Values
-
PROPERTY_CREATEDBY
public static final String PROPERTY_CREATEDBY
Property createdBy stored in column CreatedBy in table AD_Dataset- See Also:
Traceable
, Constant Field Values
-
PROPERTY_UPDATED
public static final String PROPERTY_UPDATED
Property updated stored in column Updated in table AD_Dataset- See Also:
Traceable
, Constant Field Values
-
PROPERTY_UPDATEDBY
public static final String PROPERTY_UPDATEDBY
Property updatedBy stored in column UpdatedBy in table AD_Dataset- See Also:
Traceable
, Constant Field Values
-
PROPERTY_SEARCHKEY
public static final String PROPERTY_SEARCHKEY
Property searchKey stored in column Value in table AD_Dataset
Help: A search key allows for a fast method of finding a particular record. If you leave the search key empty, the system automatically creates a numeric number originating from a document sequence defined in the "Document Sequence" window. The sequence naming convention follows a rule "DocumentNo_TableName", where TableName is the actual name of the database table (e.g. C_Order). Usually, company's internal identifiers for various records (products, customers, etc) are stored here.- See Also:
- Constant Field Values
-
PROPERTY_NAME
public static final String PROPERTY_NAME
Property name stored in column Name in table AD_Dataset- See Also:
- Constant Field Values
-
PROPERTY_DESCRIPTION
public static final String PROPERTY_DESCRIPTION
Property description stored in column Description in table AD_Dataset
Help: A description is limited to 255 characters.- See Also:
- Constant Field Values
-
PROPERTY_MODULE
public static final String PROPERTY_MODULE
Property module stored in column AD_Module_ID in table AD_Dataset
Help: Indicates the module the element forms part of.- See Also:
- Constant Field Values
-
PROPERTY_EXPORT
public static final String PROPERTY_EXPORT
Property export stored in column Export in table AD_Dataset
Help: Export Reference Data to a XML file- See Also:
- Constant Field Values
-
PROPERTY_DATAACCESSLEVEL
public static final String PROPERTY_DATAACCESSLEVEL
Property dataAccessLevel stored in column Accesslevel in table AD_Dataset
Help: Indicates what type of data (in terms of AD_CLIENT and AD_ORG data columns) can be entered or viewed. We can classify data in 4 major categories: - System (AD_CLIENT_ID=0, AD_ORG_ID=0) - system data (such as metadata for window, tab and field definition) - Organization (AD_CLIENT<>0, AD_ORG_ID<>0) - data particular to an organization (such as sales orders) - Client/Organization (AD_CLIENT<>0, AD_ORG_ID=anything) - data particular to an organization or shared among all organizations within one client - Client (AD_CLIENT<>0, AD_ORG_ID=0) - data that is specific to a client but can be used by all organizations within that client or All (AD_CLIENT=anything, AD_ORG_ID=anything)- See Also:
- Constant Field Values
-
PROPERTY_EXPORTALLOWED
public static final String PROPERTY_EXPORTALLOWED
Property exportAllowed stored in column ExportAllowed in table AD_Dataset
Help: This data set can be exported. There are datasets which are not meant to be exported, such as the AD dataset (which contains the set of tables which define the Application Dictionary), or the Client dataset. If the dataset needs to be exported via the Export Dataset functionality, this check should be marked. If it's going to be used for another purpose, and its data content doesn't need to be included inside the modules, then it should be unchecked.- See Also:
- Constant Field Values
-
PROPERTY_CHECKSUM
public static final String PROPERTY_CHECKSUM
Property checksum stored in column Checksum in table AD_Dataset
Help: The checksum information is used to verify whether the version of the dataset which was imported in the database is up to date, or needs to be updated.- See Also:
- Constant Field Values
-
PROPERTY_SEQUENCENUMBER
public static final String PROPERTY_SEQUENCENUMBER
Property sequenceNumber stored in column Seqno in table AD_Dataset
Help: The Sequence indicates the order of records- See Also:
- Constant Field Values
-
PROPERTY_DEFAULTVALUESDATASET
public static final String PROPERTY_DEFAULTVALUESDATASET
Property defaultValuesDataSet stored in column IsDefaultValuesDataSet in table AD_Dataset
Help: Data sets marked as "Default Values Data Set" import data as default values. The owner of this data once imported is not the data set anymore but the instance. This means that subsequent data set updates will not modify this data, though they can add new rows, preserving any change performed in the instance where they were initially imported.- See Also:
- Constant Field Values
-
PROPERTY_DATASETTABLELIST
public static final String PROPERTY_DATASETTABLELIST
Property dataSetTableList stored in table AD_Dataset- 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
-
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
-
getSearchKey
public String getSearchKey()
- See Also:
PROPERTY_SEARCHKEY
-
setSearchKey
public void setSearchKey(String searchKey)
- See Also:
PROPERTY_SEARCHKEY
-
getName
public String getName()
- See Also:
PROPERTY_NAME
-
setName
public void setName(String name)
- See Also:
PROPERTY_NAME
-
getDescription
public String getDescription()
- See Also:
PROPERTY_DESCRIPTION
-
setDescription
public void setDescription(String description)
- See Also:
PROPERTY_DESCRIPTION
-
getModule
public Module getModule()
- See Also:
PROPERTY_MODULE
-
setModule
public void setModule(Module module)
- See Also:
PROPERTY_MODULE
-
isExport
public Boolean isExport()
- See Also:
PROPERTY_EXPORT
-
setExport
public void setExport(Boolean export)
- See Also:
PROPERTY_EXPORT
-
getDataAccessLevel
public String getDataAccessLevel()
- See Also:
PROPERTY_DATAACCESSLEVEL
-
setDataAccessLevel
public void setDataAccessLevel(String dataAccessLevel)
- See Also:
PROPERTY_DATAACCESSLEVEL
-
isExportAllowed
public Boolean isExportAllowed()
- See Also:
PROPERTY_EXPORTALLOWED
-
setExportAllowed
public void setExportAllowed(Boolean exportAllowed)
- See Also:
PROPERTY_EXPORTALLOWED
-
getChecksum
public String getChecksum()
- See Also:
PROPERTY_CHECKSUM
-
setChecksum
public void setChecksum(String checksum)
- See Also:
PROPERTY_CHECKSUM
-
getSequenceNumber
public Long getSequenceNumber()
- See Also:
PROPERTY_SEQUENCENUMBER
-
setSequenceNumber
public void setSequenceNumber(Long sequenceNumber)
- See Also:
PROPERTY_SEQUENCENUMBER
-
isDefaultValuesDataSet
public Boolean isDefaultValuesDataSet()
- See Also:
PROPERTY_DEFAULTVALUESDATASET
-
setDefaultValuesDataSet
public void setDefaultValuesDataSet(Boolean defaultValuesDataSet)
- See Also:
PROPERTY_DEFAULTVALUESDATASET
-
getDataSetTableList
public List<DataSetTable> getDataSetTableList()
Help: Tables of a Dataset.- See Also:
DataSetTable
-
setDataSetTableList
public void setDataSetTableList(List<DataSetTable> dataSetTableList)
Help: Tables of a Dataset.- See Also:
DataSetTable
-
-