View source | Discuss this page | Page history | Printable version   
Toolbox
Main Page
Upload file
What links here
Recent changes
Help

PDF Books
Add page
Show collection (0 pages)
Collections help

Search

ERP/3.0/Developers Guide/Reference/Entity Model/ADSequence

This article is protected against manual editing because it is automatically generated from Openbravo meta-data. Learn more about writing and translating such documents.
Back button.png   Back to ERP/3.0/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:

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-2019 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
  ************************************************************************
 */
 package org.openbravo.model.ad.utility;
 
 import java.util.Date;
 
 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;
 /**
  * Entity class for entity ADSequence (stored in table AD_Sequence).
  * <br>
  * Help: {@literal The Sequence Tab defines the numeric sequencing to use for documents.  These can also
      *       include an alpha suffix and / or prefix.}
  * <br>
  * 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 ENTITY_NAME = "ADSequence";
 
     /**
      * Property id stored in column AD_Sequence_ID in table AD_Sequence<br>
      * Help: {@literal The Sequence defines the numbering sequence to be used for documents.}
      * 
      */
     public static final String PROPERTY_ID = "id";
 
     /**
      * Property client stored in column AD_Client_ID in table AD_Sequence 
      * @see ClientEnabled 
      * 
      */
     public static final String PROPERTY_CLIENT = "client";
 
     /**
      * Property organization stored in column AD_Org_ID in table AD_Sequence 
      * @see OrganizationEnabled 
      * 
      */
     public static final String PROPERTY_ORGANIZATION = "organization";
 
     /**
      * Property active stored in column IsActive in table AD_Sequence 
      * @see ActiveEnabled 
      * 
      */
     public static final String PROPERTY_ACTIVE = "active";
 
     /**
      * Property creationDate stored in column Created in table AD_Sequence 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATIONDATE = "creationDate";
 
     /**
      * Property createdBy stored in column CreatedBy in table AD_Sequence 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATEDBY = "createdBy";
 
     /**
      * Property updated stored in column Updated in table AD_Sequence 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATED = "updated";
 
     /**
      * Property updatedBy stored in column UpdatedBy in table AD_Sequence 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATEDBY = "updatedBy";
 
     /**
      * Property name stored in column Name in table AD_Sequence 
      * 
      */
     public static final String PROPERTY_NAME = "name";
 
     /**
      * Property description stored in column Description in table AD_Sequence<br>
      * Help: {@literal A description is limited to 255 characters.}
      * 
      */
     public static final String PROPERTY_DESCRIPTION = "description";
 
     /**
      * Property valueFormat stored in column VFormat in table AD_Sequence<br>
      * Help: {@literal Value Format is the format the value will be displayed with.}
      * 
      */
     public static final String PROPERTY_VALUEFORMAT = "valueFormat";
 
     /**
      * Property autoNumbering stored in column IsAutoSequence in table AD_Sequence<br>
      * Help: {@literal The Auto Numbering checkbox indicates if the system will assign the next number
      *       automatically.}
      * 
      */
     public static final String PROPERTY_AUTONUMBERING = "autoNumbering";
 
     /**
      * Property incrementBy stored in column IncrementNo in table AD_Sequence<br>
      * Help: {@literal The Increment indicates the number to increment the last document number by to arrive at
      *       the next sequence number}
      * 
      */
     public static final String PROPERTY_INCREMENTBY = "incrementBy";
 
     /**
      * Property startingNo stored in column StartNo in table AD_Sequence<br>
      * Help: {@literal The Start Number indicates the starting position in the line or field number in the line}
      * 
      */
     public static final String PROPERTY_STARTINGNO = "startingNo";
 
     /**
      * Property nextAssignedNumber stored in column CurrentNext in table AD_Sequence<br>
      * Help: {@literal The Current Next indicates the next number to use for this document}
      * 
      */
     public static final String PROPERTY_NEXTASSIGNEDNUMBER = "nextAssignedNumber";
 
     /**
      * Property currentNextSystem stored in column CurrentNextSys in table AD_Sequence<br>
      * Help: {@literal This field is for system use only and should not be modified.}
      * 
      */
     public static final String PROPERTY_CURRENTNEXTSYSTEM = "currentNextSystem";
 
     /**
      * Property usedForRecordID stored in column IsTableID in table AD_Sequence<br>
      * Help: {@literal The Used for Record ID checkbox indicates if the document id will be used as the key to
      *       the record}
      * 
      */
     public static final String PROPERTY_USEDFORRECORDID = "usedForRecordID";
 
     /**
      * Property prefix stored in column Prefix in table AD_Sequence<br>
      * Help: {@literal The Prefix indicates the characters to print in front of the document number.}
      * 
      */
     public static final String PROPERTY_PREFIX = "prefix";
 
     /**
      * Property suffix stored in column Suffix in table AD_Sequence<br>
      * Help: {@literal The Suffix indicates the characters to append to the document number.}
      * 
      */
     public static final String PROPERTY_SUFFIX = "suffix";
 
     /**
      * Property restartSequenceEveryYear stored in column StartNewYear in table AD_Sequence<br>
      * Help: {@literal The Restart Sequence Every Year checkbox indicates that the documents sequencing should
      *       return to the starting number on the first day of the year.}
      * 
      */
     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 ENTITY_NAME;
     }
 
     /**
      * @see Sequence#PROPERTY_ID
      * 
      */
     public String getId() {
         return (String) get(PROPERTY_ID);
     }
     /**
      * @see Sequence#PROPERTY_ID
      * 
      */
     public void setId(String id) {
         set(PROPERTY_ID, id);
     }
 
     /**
      * @see Sequence#PROPERTY_CLIENT
      * 
      */
     public Client getClient() {
         return (Client) get(PROPERTY_CLIENT);
     }
     /**
      * @see Sequence#PROPERTY_CLIENT
      * 
      */
     public void setClient(Client client) {
         set(PROPERTY_CLIENT, client);
     }
 
     /**
      * @see Sequence#PROPERTY_ORGANIZATION
      * 
      */
     public Organization getOrganization() {
         return (Organization) get(PROPERTY_ORGANIZATION);
     }
     /**
      * @see Sequence#PROPERTY_ORGANIZATION
      * 
      */
     public void setOrganization(Organization organization) {
         set(PROPERTY_ORGANIZATION, organization);
     }
 
     /**
      * @see Sequence#PROPERTY_ACTIVE
      * 
      */
     public Boolean isActive() {
         return (Boolean) get(PROPERTY_ACTIVE);
     }
     /**
      * @see Sequence#PROPERTY_ACTIVE
      * 
      */
     public void setActive(Boolean active) {
         set(PROPERTY_ACTIVE, active);
     }
 
     /**
      * @see Sequence#PROPERTY_CREATIONDATE
      * 
      */
     public Date getCreationDate() {
         return (Date) get(PROPERTY_CREATIONDATE);
     }
     /**
      * @see Sequence#PROPERTY_CREATIONDATE
      * 
      */
     public void setCreationDate(Date creationDate) {
         set(PROPERTY_CREATIONDATE, creationDate);
     }
 
     /**
      * @see Sequence#PROPERTY_CREATEDBY
      * 
      */
     public User getCreatedBy() {
         return (User) get(PROPERTY_CREATEDBY);
     }
     /**
      * @see Sequence#PROPERTY_CREATEDBY
      * 
      */
     public void setCreatedBy(User createdBy) {
         set(PROPERTY_CREATEDBY, createdBy);
     }
 
     /**
      * @see Sequence#PROPERTY_UPDATED
      * 
      */
     public Date getUpdated() {
         return (Date) get(PROPERTY_UPDATED);
     }
     /**
      * @see Sequence#PROPERTY_UPDATED
      * 
      */
     public void setUpdated(Date updated) {
         set(PROPERTY_UPDATED, updated);
     }
 
     /**
      * @see Sequence#PROPERTY_UPDATEDBY
      * 
      */
     public User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     }
     /**
      * @see Sequence#PROPERTY_UPDATEDBY
      * 
      */
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     }
 
     /**
      * @see Sequence#PROPERTY_NAME
      * 
      */
     public String getName() {
         return (String) get(PROPERTY_NAME);
     }
     /**
      * @see Sequence#PROPERTY_NAME
      * 
      */
     public void setName(String name) {
         set(PROPERTY_NAME, name);
     }
 
     /**
      * @see Sequence#PROPERTY_DESCRIPTION
      * 
      */
     public String getDescription() {
         return (String) get(PROPERTY_DESCRIPTION);
     }
     /**
      * @see Sequence#PROPERTY_DESCRIPTION
      * 
      */
     public void setDescription(String description) {
         set(PROPERTY_DESCRIPTION, description);
     }
 
     /**
      * @see Sequence#PROPERTY_VALUEFORMAT
      * 
      */
     public String getValueFormat() {
         return (String) get(PROPERTY_VALUEFORMAT);
     }
     /**
      * @see Sequence#PROPERTY_VALUEFORMAT
      * 
      */
     public void setValueFormat(String valueFormat) {
         set(PROPERTY_VALUEFORMAT, valueFormat);
     }
 
     /**
      * @see Sequence#PROPERTY_AUTONUMBERING
      * 
      */
     public Boolean isAutoNumbering() {
         return (Boolean) get(PROPERTY_AUTONUMBERING);
     }
     /**
      * @see Sequence#PROPERTY_AUTONUMBERING
      * 
      */
     public void setAutoNumbering(Boolean autoNumbering) {
         set(PROPERTY_AUTONUMBERING, autoNumbering);
     }
 
     /**
      * @see Sequence#PROPERTY_INCREMENTBY
      * 
      */
     public Long getIncrementBy() {
         return (Long) get(PROPERTY_INCREMENTBY);
     }
     /**
      * @see Sequence#PROPERTY_INCREMENTBY
      * 
      */
     public void setIncrementBy(Long incrementBy) {
         set(PROPERTY_INCREMENTBY, incrementBy);
     }
 
     /**
      * @see Sequence#PROPERTY_STARTINGNO
      * 
      */
     public Long getStartingNo() {
         return (Long) get(PROPERTY_STARTINGNO);
     }
     /**
      * @see Sequence#PROPERTY_STARTINGNO
      * 
      */
     public void setStartingNo(Long startingNo) {
         set(PROPERTY_STARTINGNO, startingNo);
     }
 
     /**
      * @see Sequence#PROPERTY_NEXTASSIGNEDNUMBER
      * 
      */
     public Long getNextAssignedNumber() {
         return (Long) get(PROPERTY_NEXTASSIGNEDNUMBER);
     }
     /**
      * @see Sequence#PROPERTY_NEXTASSIGNEDNUMBER
      * 
      */
     public void setNextAssignedNumber(Long nextAssignedNumber) {
         set(PROPERTY_NEXTASSIGNEDNUMBER, nextAssignedNumber);
     }
 
     /**
      * @see Sequence#PROPERTY_CURRENTNEXTSYSTEM
      * 
      */
     public Long getCurrentNextSystem() {
         return (Long) get(PROPERTY_CURRENTNEXTSYSTEM);
     }
     /**
      * @see Sequence#PROPERTY_CURRENTNEXTSYSTEM
      * 
      */
     public void setCurrentNextSystem(Long currentNextSystem) {
         set(PROPERTY_CURRENTNEXTSYSTEM, currentNextSystem);
     }
 
     /**
      * @see Sequence#PROPERTY_USEDFORRECORDID
      * 
      */
     public Boolean isUsedForRecordID() {
         return (Boolean) get(PROPERTY_USEDFORRECORDID);
     }
     /**
      * @see Sequence#PROPERTY_USEDFORRECORDID
      * 
      */
     public void setUsedForRecordID(Boolean usedForRecordID) {
         set(PROPERTY_USEDFORRECORDID, usedForRecordID);
     }
 
     /**
      * @see Sequence#PROPERTY_PREFIX
      * 
      */
     public String getPrefix() {
         return (String) get(PROPERTY_PREFIX);
     }
     /**
      * @see Sequence#PROPERTY_PREFIX
      * 
      */
     public void setPrefix(String prefix) {
         set(PROPERTY_PREFIX, prefix);
     }
 
     /**
      * @see Sequence#PROPERTY_SUFFIX
      * 
      */
     public String getSuffix() {
         return (String) get(PROPERTY_SUFFIX);
     }
     /**
      * @see Sequence#PROPERTY_SUFFIX
      * 
      */
     public void setSuffix(String suffix) {
         set(PROPERTY_SUFFIX, suffix);
     }
 
     /**
      * @see Sequence#PROPERTY_RESTARTSEQUENCEEVERYYEAR
      * 
      */
     public Boolean isRestartSequenceEveryYear() {
         return (Boolean) get(PROPERTY_RESTARTSEQUENCEEVERYYEAR);
     }
     /**
      * @see Sequence#PROPERTY_RESTARTSEQUENCEEVERYYEAR
      * 
      */
     public void setRestartSequenceEveryYear(Boolean restartSequenceEveryYear) {
         set(PROPERTY_RESTARTSEQUENCEEVERYYEAR, restartSequenceEveryYear);
     }
 
 }

Retrieved from "http://wiki.openbravo.com/wiki/ERP/3.0/Developers_Guide/Reference/Entity_Model/ADSequence"

This page has been accessed 1,670 times. This page was last modified on 2 December 2019, at 01:48. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.