org.compiere.model.MSequence

All Implemented Interfaces:: Serializable, Cloneable, Comparator<Object>, I_AD_Sequence, I_Persistent, Evaluatee

public class MSequence extends X_AD_Sequence

Sequence Model.

Version:

$Id: MSequence.java,v 1.3 2006/07/30 00:58:04 jjanke Exp $

Author:

Jorg Janke

See Also:

Field Summary

Fields

Modifier and Type

Field

Description

static final int

INIT_NO

Start Number

static final int

INIT_SYS_NO

Start System Number

Fields inherited from class org.compiere.model.PO
ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, UUID_NEW_RECORD, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_AD_Sequence
accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_Sequence_ID, COLUMNNAME_AD_Sequence_UU, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_CurrentNext, COLUMNNAME_CurrentNextSys, COLUMNNAME_DateColumn, COLUMNNAME_DecimalPattern, COLUMNNAME_Description, COLUMNNAME_IncrementNo, COLUMNNAME_IsActive, COLUMNNAME_IsAudited, COLUMNNAME_IsAutoSequence, COLUMNNAME_IsOrgLevelSequence, COLUMNNAME_IsTableID, COLUMNNAME_Name, COLUMNNAME_OrgColumn, COLUMNNAME_Prefix, COLUMNNAME_StartNewMonth, COLUMNNAME_StartNewYear, COLUMNNAME_StartNo, COLUMNNAME_Suffix, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, COLUMNNAME_VFormat, Model, Table_ID, Table_Name
Constructor Summary

Constructors

Constructor

Description

MSequence(Properties ctx, int AD_Sequence_ID, String trxName)

Standard Constructor

MSequence(Properties ctx, int AD_Client_ID, String sequenceName, int StartNo, String trxName)

New Document Sequence Constructor

MSequence(Properties ctx, int AD_Client_ID, String tableName, String trxName)

New Document Sequence Constructor

MSequence(Properties ctx, String AD_Sequence_UU, String trxName)

UUID based Constructor

MSequence(Properties ctx, ResultSet rs, String trxName)

Load Constructor
Method Summary

Modifier and Type

Method

Description

protected boolean

beforeSave(boolean newRecord)

Called before Save for Pre-Save Operation.
Default implementation is nop, to be implemented in sub-classes that needed it.

static boolean

checkClientSequences(Properties ctx, int AD_Client_ID, String trxName)

Check/Initialize Client DocumentNo/Value Sequences

static boolean

createTableSequence(Properties ctx, String TableName, String trxName)

Create Table ID Sequence

static boolean

createTableSequence(Properties ctx, String TableName, String trxName, boolean tableID)

Create Table Sequence

static MSequence

get(Properties ctx, String tableName)

Get Sequence

static MSequence

get(Properties ctx, String tableName, String trxName)

Get the tableID sequence based on the TableName

static MSequence

get(Properties ctx, String tableName, String trxName, boolean tableID)

Get Sequence

int

getCurrentNext()

Get Current Next.

static String

getDocumentNo(int C_DocType_ID, String trxName)

Deprecated.

static String

getDocumentNo(int C_DocType_ID, String trxName, boolean definite)

Get next Document No based on Document Type

static String

getDocumentNo(int C_DocType_ID, String trxName, boolean definite, PO po)

Get next Document No based on Document Type

static String

getDocumentNo(int AD_Client_ID, String TableName, String trxName)

Get next Document No for table

static String

getDocumentNo(int AD_Client_ID, String TableName, String trxName, PO po)

Get next Document No for table (when the document doesn't have a c_doctype)

static String

getDocumentNoFromSeq(MSequence seq, String trxName, PO po)

Get next document no from sequence

int

getNextID()

Deprecated.
use the static getNextID or getDocumentNo method instead

static int

getNextID(int AD_Client_ID, String TableName)

static int

getNextID(int AD_Client_ID, String TableName, String trxName)

Get next number from table id sequence

static int

getNextOfficialID_HTTP(String TableName)

Get next official id through http call

static int

getNextProjectID_HTTP(String TableName)

Get next centralized id through http call

String

getOrgColumn()

Get Org Column.

static String

getPreliminaryNo(GridTab tab, int AD_Sequence_ID)

Get preliminary document no by year

static boolean

isExceptionCentralized(String tableName)

static boolean

isTableWithEntityType(String tableName)

void

setCurrentNext(int CurrentNext)

Set Current Next.

String

validateTableIDValue()

Validate Table Sequence Values

String

validateTableIDValue(String trxName)

Validate Table Sequence Values trxName the Transaction

Methods inherited from class org.compiere.model.X_AD_Sequence
get_AccessLevel, getAD_Sequence_ID, getAD_Sequence_UU, getCurrentNextSys, getDateColumn, getDecimalPattern, getDescription, getIncrementNo, getKeyNamePair, getName, getPrefix, getStartNo, getSuffix, getVFormat, initPO, isAudited, isAutoSequence, isOrgLevelSequence, isStartNewMonth, isStartNewYear, isTableID, setAD_Sequence_ID, setAD_Sequence_UU, setCurrentNextSys, setDateColumn, setDecimalPattern, setDescription, setIncrementNo, setIsAudited, setIsAutoSequence, setIsOrgLevelSequence, setIsTableID, setName, setOrgColumn, setPrefix, setStartNewMonth, setStartNewYear, setStartNo, setSuffix, setVFormat, toString

Methods inherited from class org.compiere.model.PO
afterDelete, afterSave, beforeDelete, buildInsertSQL, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, toInsertSQL, unlock, update_Tree, validForeignKeys

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator
reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_AD_Sequence
getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent
save

Field Details
- INIT_NO
  
  public static final int INIT_NO
  
  Start Number
  See Also:
  
  Constant Field Values
- INIT_SYS_NO
  
  public static final int INIT_SYS_NO
  
  Start System Number
  See Also:
  
  Constant Field Values
Constructor Details
- MSequence
  
  public MSequence(Properties ctx, String AD_Sequence_UU, String trxName)
  
  UUID based Constructor
  
  Parameters:
  
  ctx - Context
  
  AD_Sequence_UU - UUID key
  
  trxName - Transaction
- MSequence
  
  public MSequence(Properties ctx, int AD_Sequence_ID, String trxName)
  
  Standard Constructor
  
  Parameters:
  
  ctx - context
  
  AD_Sequence_ID - id
  
  trxName - transaction
- MSequence
  
  public MSequence(Properties ctx, ResultSet rs, String trxName)
  
  Load Constructor
  
  Parameters:
  
  ctx - context
  
  rs - result set
  
  trxName - transaction
- MSequence
  
  public MSequence(Properties ctx, int AD_Client_ID, String tableName, String trxName)
  
  New Document Sequence Constructor
  
  Parameters:
  
  ctx - context
  
  AD_Client_ID - owner
  
  tableName - name
  
  trxName - transaction
- MSequence
  
  public MSequence(Properties ctx, int AD_Client_ID, String sequenceName, int StartNo, String trxName)
  
  New Document Sequence Constructor
  
  Parameters:
  
  ctx - context
  
  AD_Client_ID - owner
  
  sequenceName - name
  
  StartNo - start
  
  trxName - trx
Method Details
- getNextID
  
  public static int getNextID(int AD_Client_ID, String TableName)
  
  Parameters:
  
  AD_Client_ID -
  
  TableName -
  
  Returns:
  
  next id from table id sequence
- getNextID
  
  public static int getNextID(int AD_Client_ID, String TableName, String trxName)
  
  Get next number from table id sequence
  
  Parameters:
  
  AD_Client_ID - client
  
  TableName - table name
  
  trxName -
  
  Returns:
  
  next id or (-1=not found, -2=error)
- getDocumentNo
  
  public static String getDocumentNo(int AD_Client_ID, String TableName, String trxName)
  
  Get next Document No for table
  
  Parameters:
  
  AD_Client_ID - client
  
  TableName - table name
  
  trxName - optional Transaction Name
  
  Returns:
  
  document no or null
- getDocumentNo
  
  public static String getDocumentNo(int AD_Client_ID, String TableName, String trxName, PO po)
  
  Get next Document No for table (when the document doesn't have a c_doctype)
  
  Parameters:
  
  AD_Client_ID - client
  
  TableName - table name
  
  trxName - optional Transaction Name
  
  po - - used to get the date, org and parse context variables
  
  Returns:
  
  document no or null
- getDocumentNoFromSeq
  
  public static String getDocumentNoFromSeq(MSequence seq, String trxName, PO po)
  
  Get next document no from sequence
  
  Parameters:
  
  seq -
  
  trxName -
  
  po -
  
  Returns:
  
  document no or null
- getDocumentNo
  
  @Deprecated public static String getDocumentNo(int C_DocType_ID, String trxName)
  
  Deprecated.
  
  Get Document No based on Document Type
  
  Parameters:
  
  C_DocType_ID - document type
  
  trxName - optional Transaction Name
  
  Returns:
  
  document no or null
- getDocumentNo
  
  public static String getDocumentNo(int C_DocType_ID, String trxName, boolean definite)
  
  Get next Document No based on Document Type
  
  Parameters:
  
  C_DocType_ID - document type
  
  trxName - optional Transaction Name
  
  definite - asking for a definitive or temporary sequence
  
  Returns:
  
  document no or null
- getDocumentNo
  
  public static String getDocumentNo(int C_DocType_ID, String trxName, boolean definite, PO po)
  
  Get next Document No based on Document Type
  
  Parameters:
  
  C_DocType_ID - document type
  
  trxName - optional Transaction Name
  
  definite - asking for a definitive or temporary sequence
  
  po -
  
  Returns:
  
  document no or null
- checkClientSequences
  
  public static boolean checkClientSequences(Properties ctx, int AD_Client_ID, String trxName)
  
  Check/Initialize Client DocumentNo/Value Sequences
  
  Parameters:
  
  ctx - context
  
  AD_Client_ID - client
  
  trxName - transaction
  
  Returns:
  
  true if no error
- createTableSequence
  
  public static boolean createTableSequence(Properties ctx, String TableName, String trxName)
  
  Create Table ID Sequence
  
  Parameters:
  
  ctx -
  
  TableName -
  
  trxName -
  
  Returns:
  
  true if created
- createTableSequence
  
  public static boolean createTableSequence(Properties ctx, String TableName, String trxName, boolean tableID)
  
  Create Table Sequence
  
  Parameters:
  
  ctx - context
  
  TableName - table name
  
  trxName - transaction
  
  tableID - true for table id sequence, false for documentno/value sequence
  
  Returns:
  
  true if created
- get
  
  public static MSequence get(Properties ctx, String tableName)
  
  Get Sequence
  
  Parameters:
  
  ctx - context
  
  tableName - table name
  
  Returns:
  
  Sequence
- get
  
  public static MSequence get(Properties ctx, String tableName, String trxName)
  
  Get the tableID sequence based on the TableName
  
  Parameters:
  
  ctx -
  
  tableName -
  
  trxName -
  
  Returns:
  
  sequence
- get
  
  public static MSequence get(Properties ctx, String tableName, String trxName, boolean tableID)
  
  Get Sequence
  
  Parameters:
  
  ctx - context
  
  tableName - table name
  
  trxName - optional transaction name
  
  tableID - IsTableID flag
  
  Returns:
  
  Sequence
- getNextID
  
  @Deprecated public int getNextID()
  
  Deprecated.
  use the static getNextID or getDocumentNo method instead
  
  Get Next No and increase current next
  
  Returns:
  
  next no to use
- validateTableIDValue
  
  public String validateTableIDValue()
  
  Validate Table Sequence Values
  
  Returns:
  
  info
- validateTableIDValue
  
  public String validateTableIDValue(String trxName)
  
  Validate Table Sequence Values trxName the Transaction
  
  Returns:
  
  info
- getCurrentNext
  
  public int getCurrentNext()
  
  Description copied from class: X_AD_Sequence
  
  Get Current Next.
  
  Specified by:
  
  getCurrentNext in interface I_AD_Sequence
  
  Overrides:
  
  getCurrentNext in class X_AD_Sequence
  
  Returns:
  
  The next number to be used
- setCurrentNext
  
  public void setCurrentNext(int CurrentNext)
  
  Description copied from class: X_AD_Sequence
  
  Set Current Next.
  
  Specified by:
  
  setCurrentNext in interface I_AD_Sequence
  
  Overrides:
  
  setCurrentNext in class X_AD_Sequence
  
  Parameters:
  
  CurrentNext - The next number to be used
- getNextOfficialID_HTTP
  
  public static int getNextOfficialID_HTTP(String TableName)
  
  Get next official id through http call
  
  Parameters:
  
  TableName - table name
  
  Returns:
  
  next official id or (-1=error)
- getNextProjectID_HTTP
  
  public static int getNextProjectID_HTTP(String TableName)
  
  Get next centralized id through http call
  
  Parameters:
  
  TableName - table name
  
  Returns:
  
  next centralized id or (-1=error)
- isExceptionCentralized
  
  public static boolean isExceptionCentralized(String tableName)
  
  Parameters:
  
  tableName -
  
  Returns:
  
  true if centralized id shouldn't be used for tableName
- isTableWithEntityType
  
  public static boolean isTableWithEntityType(String tableName)
  
  Parameters:
  
  tableName -
  
  Returns:
  
  true if table has entity type column
- beforeSave
  
  protected boolean beforeSave(boolean newRecord)
  
  Description copied from class: PO
  
  Called before Save for Pre-Save Operation.
  Default implementation is nop, to be implemented in sub-classes that needed it.
  
  Overrides:
  
  beforeSave in class PO
  
  Parameters:
  
  newRecord - true if it is a new record
  
  Returns:
  
  true if record can be saved
- getPreliminaryNo
  
  public static String getPreliminaryNo(GridTab tab, int AD_Sequence_ID)
  
  Get preliminary document no by year
  
  Parameters:
  
  tab -
  
  AD_Sequence_ID -
  
  Returns:
  
  Preliminary document no
- getOrgColumn
  
  public String getOrgColumn()
  
  Description copied from class: X_AD_Sequence
  
  Get Org Column.
  
  Specified by:
  
  getOrgColumn in interface I_AD_Sequence
  
  Overrides:
  
  getOrgColumn in class X_AD_Sequence
  
  Returns:
  
  Fully qualified Organization column (AD_Org_ID)

Class MSequence

Field Summary

Fields inherited from class org.compiere.model.PO

Fields inherited from interface org.compiere.model.I_AD_Sequence

Constructor Summary

Method Summary

Methods inherited from class org.compiere.model.X_AD_Sequence

Methods inherited from class org.compiere.model.PO

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Comparator

Methods inherited from interface org.compiere.model.I_AD_Sequence

Methods inherited from interface org.compiere.model.I_Persistent

Field Details

INIT_NO

INIT_SYS_NO

Constructor Details

MSequence

MSequence

MSequence

MSequence

MSequence

Method Details

getNextID

getNextID

getDocumentNo

getDocumentNo

getDocumentNoFromSeq

getDocumentNo

getDocumentNo

getDocumentNo

checkClientSequences

createTableSequence

createTableSequence

get

get

get

getNextID

validateTableIDValue

validateTableIDValue

getCurrentNext

setCurrentNext

getNextOfficialID_HTTP

getNextProjectID_HTTP

isExceptionCentralized

isTableWithEntityType

beforeSave

getPreliminaryNo

getOrgColumn