Class GLBatch
- java.lang.Object
-
- org.openbravo.base.structure.BaseOBObject
-
- org.openbravo.model.financialmgmt.gl.GLBatch
-
- All Implemented Interfaces:
Serializable
,BaseOBObjectDef
,OBNotSingleton
,OBProvidable
,ActiveEnabled
,ClientEnabled
,DynamicEnabled
,Identifiable
,OrganizationEnabled
,Traceable
public class GLBatch extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled
Entity class for entity FinancialMgmtGLBatch (stored in table GL_JournalBatch).
Help: The GL Journal Batch Tab defines the control parameters for a Journal Batch. A Batch can consist of multiple Journals.
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_ACCOUNTINGDATE
Property accountingDate stored in column DateAcct in table GL_JournalBatch
Help: The date this transaction is recorded on in the general ledger. This date also indicates which accounting period within the fiscal year this transaction will be part of.static String
PROPERTY_ACTIVE
Property active stored in column IsActive in table GL_JournalBatchstatic String
PROPERTY_CLIENT
Property client stored in column AD_Client_ID in table GL_JournalBatchstatic String
PROPERTY_CONTROLAMOUNT
Property controlAmount stored in column ControlAmt in table GL_JournalBatch
Help: If the control amount is zero, no check is performed.Otherwise the total Debit amount must be equal to the control amount, before the document is processed.static String
PROPERTY_COPYFROM
Property copyFrom stored in column CopyFrom in table GL_JournalBatch
Help: Copy lines (products) from another document of the same type.static String
PROPERTY_CREATEDBY
Property createdBy stored in column CreatedBy in table GL_JournalBatchstatic String
PROPERTY_CREATIONDATE
Property creationDate stored in column Created in table GL_JournalBatchstatic String
PROPERTY_CURRENCY
Property currency stored in column C_Currency_ID in table GL_JournalBatch
Help: Indicates the currency to be used when processing this document.static String
PROPERTY_DESCRIPTION
Property description stored in column Description in table GL_JournalBatch
Help: A description is limited to 255 characters.static String
PROPERTY_DOCUMENTDATE
Property documentDate stored in column DateDoc in table GL_JournalBatch
Help: The Document Date indicates the date the document was generated. It may or may not be the same as the accounting date.static String
PROPERTY_DOCUMENTNO
Property documentNo stored in column DocumentNo in table GL_JournalBatchstatic String
PROPERTY_FINANCIALMGMTGLJOURNALLIST
Property financialMgmtGLJournalList stored in table GL_JournalBatchstatic String
PROPERTY_GLCATEGORY
Property gLCategory stored in column GL_Category_ID in table GL_JournalBatch
Help: The General Ledger Category is an optional, user defined method of grouping journal lines.static String
PROPERTY_ID
Property id stored in column GL_JournalBatch_ID in table GL_JournalBatch
Help: The General Ledger Journal Batch identifies a group of journals to be processed as a group.static String
PROPERTY_ORGANIZATION
Property organization stored in column AD_Org_ID in table GL_JournalBatchstatic String
PROPERTY_PERIOD
Property period stored in column C_Period_ID in table GL_JournalBatch
Help: The Period indicates an exclusive range of dates for a calendar.static String
PROPERTY_POSTINGTYPE
Property postingType stored in column PostingType in table GL_JournalBatch
Help: The Posting Type indicates the type of amount (Actual, Encumbrance, Budget) this journal updated.static String
PROPERTY_PROCESSED
Property processed stored in column Processed in table GL_JournalBatch
Help: The Processed checkbox indicates that a document has been processed.static String
PROPERTY_PROCESSNOW
Property processNow stored in column Processing in table GL_JournalBatch
Help: When this field is set as 'Y' a process is being performed on this record.static String
PROPERTY_TEMPLATE
Property template stored in column IsTemplate in table GL_JournalBatch
Help: Template is checked when the element is used as a template.static String
PROPERTY_TOTALCREDITAMOUNT
Property totalCreditAmount stored in column TotalCr in table GL_JournalBatch
Help: The Total Credit indicates the total credit amount for a journal or journal batch in the source currencystatic String
PROPERTY_TOTALDEBITAMOUNT
Property totalDebitAmount stored in column TotalDr in table GL_JournalBatch
Help: The Total Debit indicates the total debit amount for a journal or journal batch in the source currencystatic String
PROPERTY_UPDATED
Property updated stored in column Updated in table GL_JournalBatchstatic String
PROPERTY_UPDATEDBY
Property updatedBy stored in column UpdatedBy in table GL_JournalBatchstatic String
TABLE_NAME
-
Fields inherited from class org.openbravo.base.structure.BaseOBObject
ID
-
-
Constructor Summary
Constructors Constructor Description GLBatch()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Date
getAccountingDate()
Client
getClient()
Client fieldBigDecimal
getControlAmount()
User
getCreatedBy()
Created by audit userDate
getCreationDate()
Creation date of auditCurrency
getCurrency()
String
getDescription()
Date
getDocumentDate()
String
getDocumentNo()
String
getEntityName()
List<GLJournal>
getFinancialMgmtGLJournalList()
Help: The GL Journal Tab defines the control parameters for a single GL Journal.GLCategory
getGLCategory()
String
getId()
Organization
getOrganization()
Gets organization fieldPeriod
getPeriod()
String
getPostingType()
BigDecimal
getTotalCreditAmount()
BigDecimal
getTotalDebitAmount()
Date
getUpdated()
Update date of auditUser
getUpdatedBy()
Update by audit userBoolean
isActive()
Gets active fieldBoolean
isCopyFrom()
Boolean
isProcessed()
Boolean
isProcessNow()
Boolean
isTemplate()
void
setAccountingDate(Date accountingDate)
void
setActive(Boolean active)
Sets active fieldvoid
setClient(Client client)
Client fieldvoid
setControlAmount(BigDecimal controlAmount)
void
setCopyFrom(Boolean copyFrom)
void
setCreatedBy(User createdBy)
Created by audit uservoid
setCreationDate(Date creationDate)
Creation date of auditvoid
setCurrency(Currency currency)
void
setDescription(String description)
void
setDocumentDate(Date documentDate)
void
setDocumentNo(String documentNo)
void
setFinancialMgmtGLJournalList(List<GLJournal> financialMgmtGLJournalList)
Help: The GL Journal Tab defines the control parameters for a single GL Journal.void
setGLCategory(GLCategory gLCategory)
void
setId(String id)
void
setOrganization(Organization organization)
Sets organization fieldvoid
setPeriod(Period period)
void
setPostingType(String postingType)
void
setProcessed(Boolean processed)
void
setProcessNow(Boolean processNow)
void
setTemplate(Boolean template)
void
setTotalCreditAmount(BigDecimal totalCreditAmount)
void
setTotalDebitAmount(BigDecimal totalDebitAmount)
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 GL_JournalBatch_ID in table GL_JournalBatch
Help: The General Ledger Journal Batch identifies a group of journals to be processed as a group.- See Also:
- Constant Field Values
-
PROPERTY_CLIENT
public static final String PROPERTY_CLIENT
Property client stored in column AD_Client_ID in table GL_JournalBatch- See Also:
ClientEnabled
, Constant Field Values
-
PROPERTY_ORGANIZATION
public static final String PROPERTY_ORGANIZATION
Property organization stored in column AD_Org_ID in table GL_JournalBatch- See Also:
OrganizationEnabled
, Constant Field Values
-
PROPERTY_ACTIVE
public static final String PROPERTY_ACTIVE
Property active stored in column IsActive in table GL_JournalBatch- See Also:
ActiveEnabled
, Constant Field Values
-
PROPERTY_CREATIONDATE
public static final String PROPERTY_CREATIONDATE
Property creationDate stored in column Created in table GL_JournalBatch- See Also:
Traceable
, Constant Field Values
-
PROPERTY_CREATEDBY
public static final String PROPERTY_CREATEDBY
Property createdBy stored in column CreatedBy in table GL_JournalBatch- See Also:
Traceable
, Constant Field Values
-
PROPERTY_UPDATED
public static final String PROPERTY_UPDATED
Property updated stored in column Updated in table GL_JournalBatch- See Also:
Traceable
, Constant Field Values
-
PROPERTY_UPDATEDBY
public static final String PROPERTY_UPDATEDBY
Property updatedBy stored in column UpdatedBy in table GL_JournalBatch- See Also:
Traceable
, Constant Field Values
-
PROPERTY_DOCUMENTNO
public static final String PROPERTY_DOCUMENTNO
Property documentNo stored in column DocumentNo in table GL_JournalBatch- See Also:
- Constant Field Values
-
PROPERTY_DESCRIPTION
public static final String PROPERTY_DESCRIPTION
Property description stored in column Description in table GL_JournalBatch
Help: A description is limited to 255 characters.- See Also:
- Constant Field Values
-
PROPERTY_POSTINGTYPE
public static final String PROPERTY_POSTINGTYPE
Property postingType stored in column PostingType in table GL_JournalBatch
Help: The Posting Type indicates the type of amount (Actual, Encumbrance, Budget) this journal updated.- See Also:
- Constant Field Values
-
PROPERTY_GLCATEGORY
public static final String PROPERTY_GLCATEGORY
Property gLCategory stored in column GL_Category_ID in table GL_JournalBatch
Help: The General Ledger Category is an optional, user defined method of grouping journal lines.- See Also:
- Constant Field Values
-
PROPERTY_DOCUMENTDATE
public static final String PROPERTY_DOCUMENTDATE
Property documentDate stored in column DateDoc in table GL_JournalBatch
Help: The Document Date indicates the date the document was generated. It may or may not be the same as the accounting date.- See Also:
- Constant Field Values
-
PROPERTY_ACCOUNTINGDATE
public static final String PROPERTY_ACCOUNTINGDATE
Property accountingDate stored in column DateAcct in table GL_JournalBatch
Help: The date this transaction is recorded on in the general ledger. This date also indicates which accounting period within the fiscal year this transaction will be part of.- See Also:
- Constant Field Values
-
PROPERTY_PERIOD
public static final String PROPERTY_PERIOD
Property period stored in column C_Period_ID in table GL_JournalBatch
Help: The Period indicates an exclusive range of dates for a calendar.- See Also:
- Constant Field Values
-
PROPERTY_CURRENCY
public static final String PROPERTY_CURRENCY
Property currency stored in column C_Currency_ID in table GL_JournalBatch
Help: Indicates the currency to be used when processing this document.- See Also:
- Constant Field Values
-
PROPERTY_TOTALDEBITAMOUNT
public static final String PROPERTY_TOTALDEBITAMOUNT
Property totalDebitAmount stored in column TotalDr in table GL_JournalBatch
Help: The Total Debit indicates the total debit amount for a journal or journal batch in the source currency- See Also:
- Constant Field Values
-
PROPERTY_TOTALCREDITAMOUNT
public static final String PROPERTY_TOTALCREDITAMOUNT
Property totalCreditAmount stored in column TotalCr in table GL_JournalBatch
Help: The Total Credit indicates the total credit amount for a journal or journal batch in the source currency- See Also:
- Constant Field Values
-
PROPERTY_CONTROLAMOUNT
public static final String PROPERTY_CONTROLAMOUNT
Property controlAmount stored in column ControlAmt in table GL_JournalBatch
Help: If the control amount is zero, no check is performed.Otherwise the total Debit amount must be equal to the control amount, before the document is processed.- See Also:
- Constant Field Values
-
PROPERTY_PROCESSNOW
public static final String PROPERTY_PROCESSNOW
Property processNow stored in column Processing in table GL_JournalBatch
Help: When this field is set as 'Y' a process is being performed on this record.- See Also:
- Constant Field Values
-
PROPERTY_PROCESSED
public static final String PROPERTY_PROCESSED
Property processed stored in column Processed in table GL_JournalBatch
Help: The Processed checkbox indicates that a document has been processed.- See Also:
- Constant Field Values
-
PROPERTY_COPYFROM
public static final String PROPERTY_COPYFROM
Property copyFrom stored in column CopyFrom in table GL_JournalBatch
Help: Copy lines (products) from another document of the same type.- See Also:
- Constant Field Values
-
PROPERTY_TEMPLATE
public static final String PROPERTY_TEMPLATE
Property template stored in column IsTemplate in table GL_JournalBatch
Help: Template is checked when the element is used as a template.- See Also:
- Constant Field Values
-
PROPERTY_FINANCIALMGMTGLJOURNALLIST
public static final String PROPERTY_FINANCIALMGMTGLJOURNALLIST
Property financialMgmtGLJournalList stored in table GL_JournalBatch- 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
-
getDocumentNo
public String getDocumentNo()
- See Also:
PROPERTY_DOCUMENTNO
-
setDocumentNo
public void setDocumentNo(String documentNo)
- See Also:
PROPERTY_DOCUMENTNO
-
getDescription
public String getDescription()
- See Also:
PROPERTY_DESCRIPTION
-
setDescription
public void setDescription(String description)
- See Also:
PROPERTY_DESCRIPTION
-
getPostingType
public String getPostingType()
- See Also:
PROPERTY_POSTINGTYPE
-
setPostingType
public void setPostingType(String postingType)
- See Also:
PROPERTY_POSTINGTYPE
-
getGLCategory
public GLCategory getGLCategory()
- See Also:
PROPERTY_GLCATEGORY
-
setGLCategory
public void setGLCategory(GLCategory gLCategory)
- See Also:
PROPERTY_GLCATEGORY
-
getDocumentDate
public Date getDocumentDate()
- See Also:
PROPERTY_DOCUMENTDATE
-
setDocumentDate
public void setDocumentDate(Date documentDate)
- See Also:
PROPERTY_DOCUMENTDATE
-
getAccountingDate
public Date getAccountingDate()
- See Also:
PROPERTY_ACCOUNTINGDATE
-
setAccountingDate
public void setAccountingDate(Date accountingDate)
- See Also:
PROPERTY_ACCOUNTINGDATE
-
getPeriod
public Period getPeriod()
- See Also:
PROPERTY_PERIOD
-
setPeriod
public void setPeriod(Period period)
- See Also:
PROPERTY_PERIOD
-
getCurrency
public Currency getCurrency()
- See Also:
PROPERTY_CURRENCY
-
setCurrency
public void setCurrency(Currency currency)
- See Also:
PROPERTY_CURRENCY
-
getTotalDebitAmount
public BigDecimal getTotalDebitAmount()
- See Also:
PROPERTY_TOTALDEBITAMOUNT
-
setTotalDebitAmount
public void setTotalDebitAmount(BigDecimal totalDebitAmount)
- See Also:
PROPERTY_TOTALDEBITAMOUNT
-
getTotalCreditAmount
public BigDecimal getTotalCreditAmount()
- See Also:
PROPERTY_TOTALCREDITAMOUNT
-
setTotalCreditAmount
public void setTotalCreditAmount(BigDecimal totalCreditAmount)
- See Also:
PROPERTY_TOTALCREDITAMOUNT
-
getControlAmount
public BigDecimal getControlAmount()
- See Also:
PROPERTY_CONTROLAMOUNT
-
setControlAmount
public void setControlAmount(BigDecimal controlAmount)
- See Also:
PROPERTY_CONTROLAMOUNT
-
isProcessNow
public Boolean isProcessNow()
- See Also:
PROPERTY_PROCESSNOW
-
setProcessNow
public void setProcessNow(Boolean processNow)
- See Also:
PROPERTY_PROCESSNOW
-
isProcessed
public Boolean isProcessed()
- See Also:
PROPERTY_PROCESSED
-
setProcessed
public void setProcessed(Boolean processed)
- See Also:
PROPERTY_PROCESSED
-
isCopyFrom
public Boolean isCopyFrom()
- See Also:
PROPERTY_COPYFROM
-
setCopyFrom
public void setCopyFrom(Boolean copyFrom)
- See Also:
PROPERTY_COPYFROM
-
isTemplate
public Boolean isTemplate()
- See Also:
PROPERTY_TEMPLATE
-
setTemplate
public void setTemplate(Boolean template)
- See Also:
PROPERTY_TEMPLATE
-
getFinancialMgmtGLJournalList
public List<GLJournal> getFinancialMgmtGLJournalList()
Help: The GL Journal Tab defines the control parameters for a single GL Journal.- See Also:
GLJournal
-
-