ERP 2.50:Developers Guide/Reference/Entity Model/ADSequence
ADSequence
The Sequence Tab defines the numeric sequencing to use for documents. These can also include an alpha suffix and / or prefix.
To the database table (AD_Sequence) of this entity.
Properties
Note:
- Properties marked with a * are part of the Id of the Entity.
- Properties marked with a # are part of the Identifier of the Entity.
Property | Column | Constraints | Type | Description |
id* | AD_Sequence_ID | Mandatory Max Length: 32 | java.lang.String | The Sequence defines the numbering sequence to be used for documents. |
client | AD_Client_ID | Mandatory | ADClient | A Client is a company or a legal entity. You cannot share data between Clients. |
organization | AD_Org_ID | Mandatory | Organization | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. |
active | IsActive | java.lang.Boolean | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reporting. There are two reasons for de-activating and not deleting records:
(1) The system requires the record for auditing purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are existing invoices for it. By de-activating the Business Partner you prevent it from being used in future transactions. | |
creationDate | Created | Mandatory | java.util.Date | The Created field indicates the date that this record was created. |
createdBy | CreatedBy | Mandatory | ADUser | The Created By field indicates the user who created this record. |
updated | Updated | Mandatory | java.util.Date | The Updated field indicates the date that this record was updated. |
updatedBy | UpdatedBy | Mandatory | ADUser | The Updated By field indicates the user who updated this record. |
name# | Name | Mandatory Max Length: 60 | java.lang.String | A more descriptive identifier (that does need to be unique) of a record/document that is used as a default search option along with the search key (that is unique and mostly shorter). It is up to 60 characters in length. |
description | Description | Max Length: 255 | java.lang.String | A description is limited to 255 characters. |
valueFormat | VFormat | Max Length: 40 | java.lang.String | Value Format is the format the value will be displayed with. |
autoNumbering | IsAutoSequence | Mandatory | java.lang.Boolean | The Auto Numbering checkbox indicates if the system will assign the next number automatically. |
incrementBy | IncrementNo | Mandatory | java.lang.Long | The Increment indicates the number to increment the last document number by to arrive at the next sequence number |
startingNo | StartNo | Mandatory | java.lang.Long | The Start Number indicates the starting position in the line or field number in the line |
nextAssignedNumber | CurrentNext | Mandatory | java.lang.Long | The Current Next indicates the next number to use for this document |
currentNextSystem | CurrentNextSys | Mandatory | java.lang.Long | This field is for system use only and should not be modified. |
usedForRecordID | IsTableID | java.lang.Boolean | The Used for Record ID checkbox indicates if the document id will be used as the key to the record | |
prefix | Prefix | Max Length: 10 | java.lang.String | The Prefix indicates the characters to print in front of the document number. |
suffix | Suffix | Max Length: 10 | java.lang.String | The Suffix indicates the characters to append to the document number. |
restartSequenceEveryYear | StartNewYear | java.lang.Boolean | The Restart Sequence Every Year checkbox indicates that the documents sequencing should return to the starting number on the first day of the year. |
Java Entity Class
/* ************************************************************************* * The contents of this file are subject to the Openbravo Public License * Version 1.1 (the "License"), being the Mozilla Public License * Version 1.1 with a permitted attribution clause; you may not use this * file except in compliance with the License. You may obtain a copy of * the License at http://www.openbravo.com/legal/license.html * Software distributed under the License is distributed on an "AS IS" * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the * License for the specific language governing rights and limitations * under the License. * The Original Code is Openbravo ERP. * The Initial Developer of the Original Code is Openbravo SLU * All portions are Copyright (C) 2008-2010 Openbravo SLU * All Rights Reserved. * Contributor(s): ______________________________________. ************************************************************************ */ package org.openbravo.model.ad.utility; import org.openbravo.base.structure.ActiveEnabled; import org.openbravo.base.structure.BaseOBObject; import org.openbravo.base.structure.ClientEnabled; import org.openbravo.base.structure.OrganizationEnabled; import org.openbravo.base.structure.Traceable; import org.openbravo.model.ad.access.User; import org.openbravo.model.ad.system.Client; import org.openbravo.model.common.enterprise.Organization; import java.lang.Boolean; import java.lang.Long; import java.lang.String; import java.util.Date; /** * Entity class for entity ADSequence (stored in table AD_Sequence). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class Sequence extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "AD_Sequence"; public static final String ADSequence = "ADSequence"; public static final String PROPERTY_ID = "id"; public static final String PROPERTY_CLIENT = "client"; public static final String PROPERTY_ORGANIZATION = "organization"; public static final String PROPERTY_ACTIVE = "active"; public static final String PROPERTY_CREATIONDATE = "creationDate"; public static final String PROPERTY_CREATEDBY = "createdBy"; public static final String PROPERTY_UPDATED = "updated"; public static final String PROPERTY_UPDATEDBY = "updatedBy"; public static final String PROPERTY_NAME = "name"; public static final String PROPERTY_DESCRIPTION = "description"; public static final String PROPERTY_VALUEFORMAT = "valueFormat"; public static final String PROPERTY_AUTONUMBERING = "autoNumbering"; public static final String PROPERTY_INCREMENTBY = "incrementBy"; public static final String PROPERTY_STARTINGNO = "startingNo"; public static final String PROPERTY_NEXTASSIGNEDNUMBER = "nextAssignedNumber"; public static final String PROPERTY_CURRENTNEXTSYSTEM = "currentNextSystem"; public static final String PROPERTY_USEDFORRECORDID = "usedForRecordID"; public static final String PROPERTY_PREFIX = "prefix"; public static final String PROPERTY_SUFFIX = "suffix"; public static final String PROPERTY_RESTARTSEQUENCEEVERYYEAR = "restartSequenceEveryYear"; public Sequence() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_AUTONUMBERING, false); setDefaultValue(PROPERTY_INCREMENTBY, (long) 1); setDefaultValue(PROPERTY_STARTINGNO, (long) 1000000); setDefaultValue(PROPERTY_NEXTASSIGNEDNUMBER, (long) 1000000); setDefaultValue(PROPERTY_CURRENTNEXTSYSTEM, (long) 100); setDefaultValue(PROPERTY_USEDFORRECORDID, false); setDefaultValue(PROPERTY_RESTARTSEQUENCEEVERYYEAR, false); } @Override public String getEntityName() { return ADSequence; } public String getId() { return (String) get(PROPERTY_ID); } public void setId(String id) { set(PROPERTY_ID, id); } public Client getClient() { return (Client) get(PROPERTY_CLIENT); } public void setClient(Client client) { set(PROPERTY_CLIENT, client); } public Organization getOrganization() { return (Organization) get(PROPERTY_ORGANIZATION); } public void setOrganization(Organization organization) { set(PROPERTY_ORGANIZATION, organization); } public Boolean isActive() { return (Boolean) get(PROPERTY_ACTIVE); } public void setActive(Boolean active) { set(PROPERTY_ACTIVE, active); } public Date getCreationDate() { return (Date) get(PROPERTY_CREATIONDATE); } public void setCreationDate(Date creationDate) { set(PROPERTY_CREATIONDATE, creationDate); } public User getCreatedBy() { return (User) get(PROPERTY_CREATEDBY); } public void setCreatedBy(User createdBy) { set(PROPERTY_CREATEDBY, createdBy); } public Date getUpdated() { return (Date) get(PROPERTY_UPDATED); } public void setUpdated(Date updated) { set(PROPERTY_UPDATED, updated); } public User getUpdatedBy() { return (User) get(PROPERTY_UPDATEDBY); } public void setUpdatedBy(User updatedBy) { set(PROPERTY_UPDATEDBY, updatedBy); } public String getName() { return (String) get(PROPERTY_NAME); } public void setName(String name) { set(PROPERTY_NAME, name); } public String getDescription() { return (String) get(PROPERTY_DESCRIPTION); } public void setDescription(String description) { set(PROPERTY_DESCRIPTION, description); } public String getValueFormat() { return (String) get(PROPERTY_VALUEFORMAT); } public void setValueFormat(String valueFormat) { set(PROPERTY_VALUEFORMAT, valueFormat); } public Boolean isAutoNumbering() { return (Boolean) get(PROPERTY_AUTONUMBERING); } public void setAutoNumbering(Boolean autoNumbering) { set(PROPERTY_AUTONUMBERING, autoNumbering); } public Long getIncrementBy() { return (Long) get(PROPERTY_INCREMENTBY); } public void setIncrementBy(Long incrementBy) { set(PROPERTY_INCREMENTBY, incrementBy); } public Long getStartingNo() { return (Long) get(PROPERTY_STARTINGNO); } public void setStartingNo(Long startingNo) { set(PROPERTY_STARTINGNO, startingNo); } public Long getNextAssignedNumber() { return (Long) get(PROPERTY_NEXTASSIGNEDNUMBER); } public void setNextAssignedNumber(Long nextAssignedNumber) { set(PROPERTY_NEXTASSIGNEDNUMBER, nextAssignedNumber); } public Long getCurrentNextSystem() { return (Long) get(PROPERTY_CURRENTNEXTSYSTEM); } public void setCurrentNextSystem(Long currentNextSystem) { set(PROPERTY_CURRENTNEXTSYSTEM, currentNextSystem); } public Boolean isUsedForRecordID() { return (Boolean) get(PROPERTY_USEDFORRECORDID); } public void setUsedForRecordID(Boolean usedForRecordID) { set(PROPERTY_USEDFORRECORDID, usedForRecordID); } public String getPrefix() { return (String) get(PROPERTY_PREFIX); } public void setPrefix(String prefix) { set(PROPERTY_PREFIX, prefix); } public String getSuffix() { return (String) get(PROPERTY_SUFFIX); } public void setSuffix(String suffix) { set(PROPERTY_SUFFIX, suffix); } public Boolean isRestartSequenceEveryYear() { return (Boolean) get(PROPERTY_RESTARTSEQUENCEEVERYYEAR); } public void setRestartSequenceEveryYear(Boolean restartSequenceEveryYear) { set(PROPERTY_RESTARTSEQUENCEEVERYYEAR, restartSequenceEveryYear); } }