Package org.openbravo.model.ad.utility

Class Sequence

java.lang.Object

org.openbravo.base.structure.BaseOBObject

org.openbravo.model.ad.utility.Sequence

All Implemented Interfaces:

Serializable, BaseOBObjectDef, OBNotSingleton, OBProvidable, ActiveEnabled, ClientEnabled, DynamicEnabled, Identifiable, OrganizationEnabled, Traceable

public class Sequence
extends BaseOBObject
implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled

Entity class for entity ADSequence (stored in table AD_Sequence).
Help: The Sequence Tab defines the numeric sequencing to use for documents. These can also include an alpha suffix and / or prefix.
NOTE: This class should not be instantiated directly. To instantiate this class the OBProvider 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_Sequence
static String	PROPERTY_AUTONUMBERING	Property autoNumbering stored in column IsAutoSequence in table AD_Sequence Help: The Auto Numbering checkbox indicates if the system will assign the next number automatically.
static String	PROPERTY_CLIENT	Property client stored in column AD_Client_ID in table AD_Sequence
static String	PROPERTY_CREATEDBY	Property createdBy stored in column CreatedBy in table AD_Sequence
static String	PROPERTY_CREATIONDATE	Property creationDate stored in column Created in table AD_Sequence
static String	PROPERTY_CURRENTNEXTSYSTEM	Deprecated. Property marked as deprecated on field Development Status
static String	PROPERTY_DESCRIPTION	Property description stored in column Description in table AD_Sequence Help: A description is limited to 255 characters.
static String	PROPERTY_ID	Property id stored in column AD_Sequence_ID in table AD_Sequence Help: The Sequence defines the numbering sequence to be used for documents.
static String	PROPERTY_INCREMENTBY	Property incrementBy stored in column IncrementNo in table AD_Sequence Help: The Increment indicates the number to increment the last document number by to arrive at the next sequence number
static String	PROPERTY_NAME	Property name stored in column Name in table AD_Sequence
static String	PROPERTY_NEXTASSIGNEDNUMBER	Property nextAssignedNumber stored in column CurrentNext in table AD_Sequence Help: The Current Next indicates the next number to use for this document
static String	PROPERTY_ORGANIZATION	Property organization stored in column AD_Org_ID in table AD_Sequence
static String	PROPERTY_PREFIX	Property prefix stored in column Prefix in table AD_Sequence Help: The Prefix indicates the characters to print in front of the document number.
static String	PROPERTY_RESTARTSEQUENCEEVERYYEAR	Property restartSequenceEveryYear stored in column StartNewYear in table AD_Sequence Help: The Restart Sequence Every Year checkbox indicates that the documents sequencing should return to the starting number on the first day of the year.
static String	PROPERTY_STARTINGNO	Property startingNo stored in column StartNo in table AD_Sequence Help: The Start Number indicates the starting position in the line or field number in the line
static String	PROPERTY_SUFFIX	Property suffix stored in column Suffix in table AD_Sequence Help: The Suffix indicates the characters to append to the document number.
static String	PROPERTY_UPDATED	Property updated stored in column Updated in table AD_Sequence
static String	PROPERTY_UPDATEDBY	Property updatedBy stored in column UpdatedBy in table AD_Sequence
static String	PROPERTY_USEDFORRECORDID	Property usedForRecordID stored in column IsTableID in table AD_Sequence Help: The Used for Record ID checkbox indicates if the document id will be used as the key to the record
static String	PROPERTY_VALUEFORMAT	Property valueFormat stored in column VFormat in table AD_Sequence Help: Value Format is the format the value will be displayed with.
static String	TABLE_NAME

Fields inherited from class org.openbravo.base.structure.BaseOBObject

ID

Constructor Summary

Constructors

Constructor	Description
Sequence()

Method Summary

Modifier and Type	Method	Description
Client	getClient()	Client field
User	getCreatedBy()	Created by audit user
Date	getCreationDate()	Creation date of audit
Long	getCurrentNextSystem()	Deprecated. Property marked as deprecated on field Development Status
String	getDescription()
String	getEntityName()
String	getId()
Long	getIncrementBy()
String	getName()
Long	getNextAssignedNumber()
Organization	getOrganization()	Gets organization field
String	getPrefix()
Long	getStartingNo()
String	getSuffix()
Date	getUpdated()	Update date of audit
User	getUpdatedBy()	Update by audit user
String	getValueFormat()
Boolean	isActive()	Gets active field
Boolean	isAutoNumbering()
Boolean	isRestartSequenceEveryYear()
Boolean	isUsedForRecordID()
void	setActive(Boolean active)	Sets active field
void	setAutoNumbering(Boolean autoNumbering)
void	setClient(Client client)	Client field
void	setCreatedBy(User createdBy)	Created by audit user
void	setCreationDate(Date creationDate)	Creation date of audit
void	setCurrentNextSystem(Long currentNextSystem)	Deprecated. Property marked as deprecated on field Development Status
void	setDescription(String description)
void	setId(String id)
void	setIncrementBy(Long incrementBy)
void	setName(String name)
void	setNextAssignedNumber(Long nextAssignedNumber)
void	setOrganization(Organization organization)	Sets organization field
void	setPrefix(String prefix)
void	setRestartSequenceEveryYear(Boolean restartSequenceEveryYear)
void	setStartingNo(Long startingNo)
void	setSuffix(String suffix)
void	setUpdated(Date updated)	Update date of audit
void	setUpdatedBy(User updatedBy)	Update by audit user
void	setUsedForRecordID(Boolean usedForRecordID)
void	setValueFormat(String valueFormat)

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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_Sequence_ID in table AD_Sequence
Help: The Sequence defines the numbering sequence to be used for documents.

See Also:

Constant Field Values

PROPERTY_CLIENT

public static final String PROPERTY_CLIENT

Property client stored in column AD_Client_ID in table AD_Sequence

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_Sequence

See Also:

OrganizationEnabled, Constant Field Values

PROPERTY_ACTIVE

public static final String PROPERTY_ACTIVE

Property active stored in column IsActive in table AD_Sequence

See Also:

ActiveEnabled, Constant Field Values

PROPERTY_CREATIONDATE

public static final String PROPERTY_CREATIONDATE

Property creationDate stored in column Created in table AD_Sequence

See Also:

Traceable, Constant Field Values

PROPERTY_CREATEDBY

public static final String PROPERTY_CREATEDBY

Property createdBy stored in column CreatedBy in table AD_Sequence

See Also:

Traceable, Constant Field Values

PROPERTY_UPDATED

public static final String PROPERTY_UPDATED

Property updated stored in column Updated in table AD_Sequence

See Also:

Traceable, Constant Field Values

PROPERTY_UPDATEDBY

public static final String PROPERTY_UPDATEDBY

Property updatedBy stored in column UpdatedBy in table AD_Sequence

See Also:

Traceable, Constant Field Values

PROPERTY_NAME

public static final String PROPERTY_NAME

Property name stored in column Name in table AD_Sequence

See Also:

Constant Field Values

PROPERTY_DESCRIPTION

public static final String PROPERTY_DESCRIPTION

Property description stored in column Description in table AD_Sequence
Help: A description is limited to 255 characters.

See Also:

Constant Field Values

PROPERTY_VALUEFORMAT

public static final String PROPERTY_VALUEFORMAT

Property valueFormat stored in column VFormat in table AD_Sequence
Help: Value Format is the format the value will be displayed with.

See Also:

Constant Field Values

PROPERTY_AUTONUMBERING

public static final String PROPERTY_AUTONUMBERING

Property autoNumbering stored in column IsAutoSequence in table AD_Sequence
Help: The Auto Numbering checkbox indicates if the system will assign the next number automatically.

See Also:

Constant Field Values

PROPERTY_INCREMENTBY

public static final String PROPERTY_INCREMENTBY

Property incrementBy stored in column IncrementNo in table AD_Sequence
Help: The Increment indicates the number to increment the last document number by to arrive at the next sequence number

See Also:

Constant Field Values

PROPERTY_STARTINGNO

public static final String PROPERTY_STARTINGNO

Property startingNo stored in column StartNo in table AD_Sequence
Help: The Start Number indicates the starting position in the line or field number in the line

See Also:

Constant Field Values

PROPERTY_NEXTASSIGNEDNUMBER

public static final String PROPERTY_NEXTASSIGNEDNUMBER

Property nextAssignedNumber stored in column CurrentNext in table AD_Sequence
Help: The Current Next indicates the next number to use for this document

See Also:

Constant Field Values

PROPERTY_CURRENTNEXTSYSTEM

@Deprecated
public static final String PROPERTY_CURRENTNEXTSYSTEM

Deprecated.

Property marked as deprecated on field Development Status

Property currentNextSystem stored in column CurrentNextSys in table AD_Sequence
Help: This field is for system use only and should not be modified.

See Also:

Constant Field Values

PROPERTY_USEDFORRECORDID

public static final String PROPERTY_USEDFORRECORDID

Property usedForRecordID stored in column IsTableID in table AD_Sequence
Help: The Used for Record ID checkbox indicates if the document id will be used as the key to the record

See Also:

Constant Field Values

PROPERTY_PREFIX

public static final String PROPERTY_PREFIX

Property prefix stored in column Prefix in table AD_Sequence
Help: The Prefix indicates the characters to print in front of the document number.

See Also:

Constant Field Values

PROPERTY_SUFFIX

public static final String PROPERTY_SUFFIX

Property suffix stored in column Suffix in table AD_Sequence
Help: The Suffix indicates the characters to append to the document number.

See Also:

Constant Field Values

PROPERTY_RESTARTSEQUENCEEVERYYEAR

public static final String PROPERTY_RESTARTSEQUENCEEVERYYEAR

Property restartSequenceEveryYear stored in column StartNewYear in table AD_Sequence
Help: The Restart Sequence Every Year checkbox indicates that the documents sequencing should return to the starting number on the first day of the year.

See Also:

Constant Field Values

Constructor Detail

Sequence

public Sequence()

Method Detail

getEntityName

public String getEntityName()

Specified by:

getEntityName in interface Identifiable

Specified by:

getEntityName in class BaseOBObject

getId

public String getId()

Specified by:

getId in interface BaseOBObjectDef

Specified by:

getId in interface Identifiable

Overrides:

getId in class BaseOBObject

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 interface ClientEnabled

Returns:

client

See Also:

PROPERTY_CLIENT

setClient

public void setClient(Client client)

Description copied from interface: ClientEnabled

Client field

Specified by:

setClient in interface ClientEnabled

See Also:

PROPERTY_CLIENT

getOrganization

public Organization getOrganization()

Description copied from interface: OrganizationEnabled

Gets organization field

Specified by:

getOrganization in interface OrganizationEnabled

Returns:

organization

See Also:

PROPERTY_ORGANIZATION

setOrganization

public void setOrganization(Organization organization)

Description copied from interface: OrganizationEnabled

Sets organization field

Specified by:

setOrganization in interface OrganizationEnabled

See Also:

PROPERTY_ORGANIZATION

isActive

public Boolean isActive()

Description copied from interface: ActiveEnabled

Gets active field

Specified by:

isActive in interface ActiveEnabled

Returns:

active

See Also:

PROPERTY_ACTIVE

setActive

public void setActive(Boolean active)

Description copied from interface: ActiveEnabled

Sets active field

Specified by:

setActive in interface ActiveEnabled

See Also:

PROPERTY_ACTIVE

getCreationDate

public Date getCreationDate()

Description copied from interface: Traceable

Creation date of audit

Specified by:

getCreationDate in interface Traceable

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 interface Traceable

See Also:

PROPERTY_CREATIONDATE

getCreatedBy

public User getCreatedBy()

Description copied from interface: Traceable

Created by audit user

Specified by:

getCreatedBy in interface Traceable

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 interface Traceable

See Also:

PROPERTY_CREATEDBY

getUpdated

public Date getUpdated()

Description copied from interface: Traceable

Update date of audit

Specified by:

getUpdated in interface Traceable

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 interface Traceable

See Also:

PROPERTY_UPDATED

getUpdatedBy

public User getUpdatedBy()

Description copied from interface: Traceable

Update by audit user

Specified by:

getUpdatedBy in interface Traceable

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 interface Traceable

See Also:

PROPERTY_UPDATEDBY

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

getValueFormat

public String getValueFormat()

See Also:

PROPERTY_VALUEFORMAT

setValueFormat

public void setValueFormat(String valueFormat)

See Also:

PROPERTY_VALUEFORMAT

isAutoNumbering

public Boolean isAutoNumbering()

See Also:

PROPERTY_AUTONUMBERING

setAutoNumbering

public void setAutoNumbering(Boolean autoNumbering)

See Also:

PROPERTY_AUTONUMBERING

getIncrementBy

public Long getIncrementBy()

See Also:

PROPERTY_INCREMENTBY

setIncrementBy

public void setIncrementBy(Long incrementBy)

See Also:

PROPERTY_INCREMENTBY

getStartingNo

public Long getStartingNo()

See Also:

PROPERTY_STARTINGNO

setStartingNo

public void setStartingNo(Long startingNo)

See Also:

PROPERTY_STARTINGNO

getNextAssignedNumber

public Long getNextAssignedNumber()

See Also:

PROPERTY_NEXTASSIGNEDNUMBER

setNextAssignedNumber

public void setNextAssignedNumber(Long nextAssignedNumber)

See Also:

PROPERTY_NEXTASSIGNEDNUMBER

getCurrentNextSystem

@Deprecated
public Long getCurrentNextSystem()

Deprecated.

Property marked as deprecated on field Development Status

See Also:

PROPERTY_CURRENTNEXTSYSTEM

setCurrentNextSystem

@Deprecated
public void setCurrentNextSystem(Long currentNextSystem)

Deprecated.

Property marked as deprecated on field Development Status

See Also:

PROPERTY_CURRENTNEXTSYSTEM

isUsedForRecordID

public Boolean isUsedForRecordID()

See Also:

PROPERTY_USEDFORRECORDID

setUsedForRecordID

public void setUsedForRecordID(Boolean usedForRecordID)

See Also:

PROPERTY_USEDFORRECORDID

getPrefix

public String getPrefix()

See Also:

PROPERTY_PREFIX

setPrefix

public void setPrefix(String prefix)

See Also:

PROPERTY_PREFIX

getSuffix

public String getSuffix()

See Also:

PROPERTY_SUFFIX

setSuffix

public void setSuffix(String suffix)

See Also:

PROPERTY_SUFFIX

isRestartSequenceEveryYear

public Boolean isRestartSequenceEveryYear()

See Also:

PROPERTY_RESTARTSEQUENCEEVERYYEAR

setRestartSequenceEveryYear

public void setRestartSequenceEveryYear(Boolean restartSequenceEveryYear)

See Also:

PROPERTY_RESTARTSEQUENCEEVERYYEAR