Package org.openbravo.model.sales

Class SalesRegion

java.lang.Object

org.openbravo.base.structure.BaseOBObject

org.openbravo.model.sales.SalesRegion

All Implemented Interfaces:

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

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

Entity class for entity SalesRegion (stored in table C_SalesRegion).
Help: The Sales Region defines the different regions where you do business. Sales Regions can be used when generating reports or calculating commissions.
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 C_SalesRegion
static String	PROPERTY_CLIENT	Property client stored in column AD_Client_ID in table C_SalesRegion
static String	PROPERTY_CREATEDBY	Property createdBy stored in column CreatedBy in table C_SalesRegion
static String	PROPERTY_CREATIONDATE	Property creationDate stored in column Created in table C_SalesRegion
static String	PROPERTY_DEFAULT	Property default stored in column IsDefault in table C_SalesRegion Help: The Default Checkbox indicates if this record will be used as a default value.
static String	PROPERTY_DESCRIPTION	Property description stored in column Description in table C_SalesRegion Help: A description is limited to 255 characters.
static String	PROPERTY_ID	Property id stored in column C_SalesRegion_ID in table C_SalesRegion Help: The Sales Region indicates a specific area of sales coverage.
static String	PROPERTY_NAME	Property name stored in column Name in table C_SalesRegion
static String	PROPERTY_ORGANIZATION	Property organization stored in column AD_Org_ID in table C_SalesRegion
static String	PROPERTY_SALESREPRESENTATIVE	Property salesRepresentative stored in column SalesRep_ID in table C_SalesRegion Help: Indicates the sales representative responsible for the transaction that the document specifies . A valid sales representative is a business partner marked as an employee and a sales representative.
static String	PROPERTY_SEARCHKEY	Property searchKey stored in column Value in table C_SalesRegion Help: A search key allows for a fast method of finding a particular record. If you leave the search key empty, the system automatically creates a numeric number originating from a document sequence defined in the "Document Sequence" window. The sequence naming convention follows a rule "DocumentNo_TableName", where TableName is the actual name of the database table (e.g. C_Order). Usually, company's internal identifiers for various records (products, customers, etc) are stored here.
static String	PROPERTY_SUMMARYLEVEL	Property summaryLevel stored in column IsSummary in table C_SalesRegion Help: A summary entity represents a branch in a tree rather than an end-node. Summary entities are used for reporting and do not have own values.
static String	PROPERTY_UPDATED	Property updated stored in column Updated in table C_SalesRegion
static String	PROPERTY_UPDATEDBY	Property updatedBy stored in column UpdatedBy in table C_SalesRegion
static String	TABLE_NAME

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

ID

Constructor Summary

Constructors

Constructor	Description
SalesRegion()

Method Summary

Modifier and Type	Method	Description
Client	getClient()	Client field
User	getCreatedBy()	Created by audit user
Date	getCreationDate()	Creation date of audit
String	getDescription()
String	getEntityName()
String	getId()
String	getName()
Organization	getOrganization()	Gets organization field
User	getSalesRepresentative()
String	getSearchKey()
Date	getUpdated()	Update date of audit
User	getUpdatedBy()	Update by audit user
Boolean	isActive()	Gets active field
Boolean	isDefault()
Boolean	isSummaryLevel()
void	setActive(Boolean active)	Sets active field
void	setClient(Client client)	Client field
void	setCreatedBy(User createdBy)	Created by audit user
void	setCreationDate(Date creationDate)	Creation date of audit
void	setDefault(Boolean deflt)
void	setDescription(String description)
void	setId(String id)
void	setName(String name)
void	setOrganization(Organization organization)	Sets organization field
void	setSalesRepresentative(User salesRepresentative)
void	setSearchKey(String searchKey)
void	setSummaryLevel(Boolean summaryLevel)
void	setUpdated(Date updated)	Update date of audit
void	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

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 C_SalesRegion_ID in table C_SalesRegion
Help: The Sales Region indicates a specific area of sales coverage.

See Also:

Constant Field Values

PROPERTY_CLIENT

public static final String PROPERTY_CLIENT

Property client stored in column AD_Client_ID in table C_SalesRegion

See Also:

ClientEnabled, Constant Field Values

PROPERTY_ORGANIZATION

public static final String PROPERTY_ORGANIZATION

Property organization stored in column AD_Org_ID in table C_SalesRegion

See Also:

OrganizationEnabled, Constant Field Values

PROPERTY_ACTIVE

public static final String PROPERTY_ACTIVE

Property active stored in column IsActive in table C_SalesRegion

See Also:

ActiveEnabled, Constant Field Values

PROPERTY_CREATIONDATE

public static final String PROPERTY_CREATIONDATE

Property creationDate stored in column Created in table C_SalesRegion

See Also:

Traceable, Constant Field Values

PROPERTY_CREATEDBY

public static final String PROPERTY_CREATEDBY

Property createdBy stored in column CreatedBy in table C_SalesRegion

See Also:

Traceable, Constant Field Values

PROPERTY_UPDATED

public static final String PROPERTY_UPDATED

Property updated stored in column Updated in table C_SalesRegion

See Also:

Traceable, Constant Field Values

PROPERTY_UPDATEDBY

public static final String PROPERTY_UPDATEDBY

Property updatedBy stored in column UpdatedBy in table C_SalesRegion

See Also:

Traceable, Constant Field Values

PROPERTY_SEARCHKEY

public static final String PROPERTY_SEARCHKEY

Property searchKey stored in column Value in table C_SalesRegion
Help: A search key allows for a fast method of finding a particular record. If you leave the search key empty, the system automatically creates a numeric number originating from a document sequence defined in the "Document Sequence" window. The sequence naming convention follows a rule "DocumentNo_TableName", where TableName is the actual name of the database table (e.g. C_Order). Usually, company's internal identifiers for various records (products, customers, etc) are stored here.

See Also:

Constant Field Values

PROPERTY_NAME

public static final String PROPERTY_NAME

Property name stored in column Name in table C_SalesRegion

See Also:

Constant Field Values

PROPERTY_DESCRIPTION

public static final String PROPERTY_DESCRIPTION

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

See Also:

Constant Field Values

PROPERTY_SUMMARYLEVEL

public static final String PROPERTY_SUMMARYLEVEL

Property summaryLevel stored in column IsSummary in table C_SalesRegion
Help: A summary entity represents a branch in a tree rather than an end-node. Summary entities are used for reporting and do not have own values.

See Also:

Constant Field Values

PROPERTY_SALESREPRESENTATIVE

public static final String PROPERTY_SALESREPRESENTATIVE

Property salesRepresentative stored in column SalesRep_ID in table C_SalesRegion
Help: Indicates the sales representative responsible for the transaction that the document specifies . A valid sales representative is a business partner marked as an employee and a sales representative.

See Also:

Constant Field Values

PROPERTY_DEFAULT

public static final String PROPERTY_DEFAULT

Property default stored in column IsDefault in table C_SalesRegion
Help: The Default Checkbox indicates if this record will be used as a default value.

See Also:

Constant Field Values

Constructor Detail

SalesRegion

public SalesRegion()

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

getSearchKey

public String getSearchKey()

See Also:

PROPERTY_SEARCHKEY

setSearchKey

public void setSearchKey(String searchKey)

See Also:

PROPERTY_SEARCHKEY

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

isSummaryLevel

public Boolean isSummaryLevel()

See Also:

PROPERTY_SUMMARYLEVEL

setSummaryLevel

public void setSummaryLevel(Boolean summaryLevel)

See Also:

PROPERTY_SUMMARYLEVEL

getSalesRepresentative

public User getSalesRepresentative()

See Also:

PROPERTY_SALESREPRESENTATIVE

setSalesRepresentative

public void setSalesRepresentative(User salesRepresentative)

See Also:

PROPERTY_SALESREPRESENTATIVE

isDefault

public Boolean isDefault()

See Also:

PROPERTY_DEFAULT

setDefault

public void setDefault(Boolean deflt)

See Also:

PROPERTY_DEFAULT