java.lang.Object
- org.openbravo.base.structure.BaseOBObject
- - org.openbravo.model.ad.domain.Preference

All Implemented Interfaces:

Serializable, BaseOBObjectDef, OBNotSingleton, OBProvidable, ActiveEnabled, ClientEnabled, DynamicEnabled, Identifiable, InheritedAccessEnabled, OrganizationEnabled, Traceable
```
public class Preference
extends BaseOBObject
implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled, InheritedAccessEnabled
```
Entity class for entity ADPreference (stored in table AD_Preference).
Help: Defines preferences (default values) for a user.
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_Preference
`static String`	`PROPERTY_ATTRIBUTE`	Property attribute stored in column Attribute in table AD_Preference
`static String`	`PROPERTY_CLIENT`	Property client stored in column AD_Client_ID in table AD_Preference
`static String`	`PROPERTY_CREATEDBY`	Property createdBy stored in column CreatedBy in table AD_Preference
`static String`	`PROPERTY_CREATIONDATE`	Property creationDate stored in column Created in table AD_Preference
`static String`	`PROPERTY_ID`	Property id stored in column AD_Preference_ID in table AD_Preference
`static String`	`PROPERTY_INHERITEDFROM`	Property inheritedFrom stored in column Inherited_From in table AD_Preference Help: The role from which a permission has been inherited. If a permission has this field set it means that this is an inherited permission, an therefore that the role owner of the permission is able to access it because it inherits from the role defined in this field.
`static String`	`PROPERTY_MODULE`	Property module stored in column AD_Module_ID in table AD_Preference Help: Indicates the module the element forms part of.
`static String`	`PROPERTY_ORGANIZATION`	Property organization stored in column AD_Org_ID in table AD_Preference
`static String`	`PROPERTY_PROPERTY`	Property property stored in column Property in table AD_Preference
`static String`	`PROPERTY_PROPERTYLIST`	Property propertyList stored in column IsPropertyList in table AD_Preference Help: When this field is checked, the preference is defined by Property which is a selectable value from a drop down list. Properties are defined by modules. In case the field is not checked, the preference is defined by Attribute, which is a free text name.
`static String`	`PROPERTY_SEARCHKEY`	Property searchKey stored in column Value in table AD_Preference 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_SELECTED`	Property selected stored in column Selected in table AD_Preference Help: In case of conflict (multiple values for a single property), this field must be checked for one of them in order to pick this one over the rest.
`static String`	`PROPERTY_UPDATED`	Property updated stored in column Updated in table AD_Preference
`static String`	`PROPERTY_UPDATEDBY`	Property updatedBy stored in column UpdatedBy in table AD_Preference
`static String`	`PROPERTY_USERCONTACT`	Property userContact stored in column AD_User_ID in table AD_Preference Help: The User identifies a unique user in the system. This could be an internal user or a business partner contact
`static String`	`PROPERTY_VISIBLEATCLIENT`	Property visibleAtClient stored in column VisibleAt_Client_ID in table AD_Preference Help: Defines which is the preference's visibility at client level. If this value is empty the preference will be visible from all Clients.
`static String`	`PROPERTY_VISIBLEATORGANIZATION`	Property visibleAtOrganization stored in column VisibleAt_Org_ID in table AD_Preference Help: Defines which is the preference's visibility at Organization level. The preference will be visible from all organizations in the tree bellow this one. If this value is empty the preference will be visible from all Organizations.
`static String`	`PROPERTY_VISIBLEATROLE`	Property visibleAtRole stored in column VisibleAt_Role_ID in table AD_Preference Help: Defines which is the preference's visibility at Role level. If this value is empty the preference will be visible from all Roles.
`static String`	`PROPERTY_WINDOW`	Property window stored in column AD_Window_ID in table AD_Preference Help: The Window field identifies a unique Window in the system.
`static String`	`TABLE_NAME`

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

Constructor Summary

Constructors
Constructor Description

Preference()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getAttribute()`
`Client`	`getClient()`	Client field
`User`	`getCreatedBy()`	Created by audit user
`Date`	`getCreationDate()`	Creation date of audit
`String`	`getEntityName()`
`String`	`getId()`
`Role`	`getInheritedFrom()`
`Module`	`getModule()`
`Organization`	`getOrganization()`	Gets organization field
`String`	`getProperty()`
`String`	`getSearchKey()`
`Date`	`getUpdated()`	Update date of audit
`User`	`getUpdatedBy()`	Update by audit user
`User`	`getUserContact()`
`Client`	`getVisibleAtClient()`
`Organization`	`getVisibleAtOrganization()`
`Role`	`getVisibleAtRole()`
`Window`	`getWindow()`
`Boolean`	`isActive()`	Gets active field
`Boolean`	`isPropertyList()`
`Boolean`	`isSelected()`
`void`	`setActive(Boolean active)`	Sets active field
`void`	`setAttribute(String attribute)`
`void`	`setClient(Client client)`	Client field
`void`	`setCreatedBy(User createdBy)`	Created by audit user
`void`	`setCreationDate(Date creationDate)`	Creation date of audit
`void`	`setId(String id)`
`void`	`setInheritedFrom(Role inheritedFrom)`
`void`	`setModule(Module module)`
`void`	`setOrganization(Organization organization)`	Sets organization field
`void`	`setProperty(String property)`
`void`	`setPropertyList(Boolean propertyList)`
`void`	`setSearchKey(String searchKey)`
`void`	`setSelected(Boolean selected)`
`void`	`setUpdated(Date updated)`	Update date of audit
`void`	`setUpdatedBy(User updatedBy)`	Update by audit user
`void`	`setUserContact(User userContact)`
`void`	`setVisibleAtClient(Client visibleAtClient)`
`void`	`setVisibleAtOrganization(Organization visibleAtOrganization)`
`void`	`setVisibleAtRole(Role visibleAtRole)`
`void`	`setWindow(Window window)`

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_Preference_ID in table AD_Preference
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CLIENT
```
public static final String PROPERTY_CLIENT
```
    Property client stored in column AD_Client_ID in table AD_Preference
    
    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_Preference
    
    See Also:
    
    OrganizationEnabled, Constant Field Values
  - PROPERTY_ACTIVE
```
public static final String PROPERTY_ACTIVE
```
    Property active stored in column IsActive in table AD_Preference
    
    See Also:
    
    ActiveEnabled, Constant Field Values
  - PROPERTY_CREATIONDATE
```
public static final String PROPERTY_CREATIONDATE
```
    Property creationDate stored in column Created in table AD_Preference
    
    See Also:
    
    Traceable, Constant Field Values
  - PROPERTY_CREATEDBY
```
public static final String PROPERTY_CREATEDBY
```
    Property createdBy stored in column CreatedBy in table AD_Preference
    
    See Also:
    
    Traceable, Constant Field Values
  - PROPERTY_UPDATED
```
public static final String PROPERTY_UPDATED
```
    Property updated stored in column Updated in table AD_Preference
    
    See Also:
    
    Traceable, Constant Field Values
  - PROPERTY_UPDATEDBY
```
public static final String PROPERTY_UPDATEDBY
```
    Property updatedBy stored in column UpdatedBy in table AD_Preference
    
    See Also:
    
    Traceable, Constant Field Values
  - PROPERTY_WINDOW
```
public static final String PROPERTY_WINDOW
```
    Property window stored in column AD_Window_ID in table AD_Preference
    Help: The Window field identifies a unique Window in the system.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_USERCONTACT
```
public static final String PROPERTY_USERCONTACT
```
    Property userContact stored in column AD_User_ID in table AD_Preference
    Help: The User identifies a unique user in the system. This could be an internal user or a business partner contact
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ATTRIBUTE
```
public static final String PROPERTY_ATTRIBUTE
```
    Property attribute stored in column Attribute in table AD_Preference
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SEARCHKEY
```
public static final String PROPERTY_SEARCHKEY
```
    Property searchKey stored in column Value in table AD_Preference
    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_PROPERTY
```
public static final String PROPERTY_PROPERTY
```
    Property property stored in column Property in table AD_Preference
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PROPERTYLIST
```
public static final String PROPERTY_PROPERTYLIST
```
    Property propertyList stored in column IsPropertyList in table AD_Preference
    Help: When this field is checked, the preference is defined by Property which is a selectable value from a drop down list. Properties are defined by modules. In case the field is not checked, the preference is defined by Attribute, which is a free text name.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_VISIBLEATCLIENT
```
public static final String PROPERTY_VISIBLEATCLIENT
```
    Property visibleAtClient stored in column VisibleAt_Client_ID in table AD_Preference
    Help: Defines which is the preference's visibility at client level. If this value is empty the preference will be visible from all Clients.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_VISIBLEATORGANIZATION
```
public static final String PROPERTY_VISIBLEATORGANIZATION
```
    Property visibleAtOrganization stored in column VisibleAt_Org_ID in table AD_Preference
    Help: Defines which is the preference's visibility at Organization level. The preference will be visible from all organizations in the tree bellow this one. If this value is empty the preference will be visible from all Organizations.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_VISIBLEATROLE
```
public static final String PROPERTY_VISIBLEATROLE
```
    Property visibleAtRole stored in column VisibleAt_Role_ID in table AD_Preference
    Help: Defines which is the preference's visibility at Role level. If this value is empty the preference will be visible from all Roles.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SELECTED
```
public static final String PROPERTY_SELECTED
```
    Property selected stored in column Selected in table AD_Preference
    Help: In case of conflict (multiple values for a single property), this field must be checked for one of them in order to pick this one over the rest.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_MODULE
```
public static final String PROPERTY_MODULE
```
    Property module stored in column AD_Module_ID in table AD_Preference
    Help: Indicates the module the element forms part of.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_INHERITEDFROM
```
public static final String PROPERTY_INHERITEDFROM
```
    Property inheritedFrom stored in column Inherited_From in table AD_Preference
    Help: The role from which a permission has been inherited. If a permission has this field set it means that this is an inherited permission, an therefore that the role owner of the permission is able to access it because it inherits from the role defined in this field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Preference
```
public Preference()
```
- 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
  - getWindow
```
public Window getWindow()
```
    See Also:
    
    PROPERTY_WINDOW
  - setWindow
```
public void setWindow(Window window)
```
    See Also:
    
    PROPERTY_WINDOW
  - getUserContact
```
public User getUserContact()
```
    See Also:
    
    PROPERTY_USERCONTACT
  - setUserContact
```
public void setUserContact(User userContact)
```
    See Also:
    
    PROPERTY_USERCONTACT
  - getAttribute
```
public String getAttribute()
```
    See Also:
    
    PROPERTY_ATTRIBUTE
  - setAttribute
```
public void setAttribute(String attribute)
```
    See Also:
    
    PROPERTY_ATTRIBUTE
  - getSearchKey
```
public String getSearchKey()
```
    See Also:
    
    PROPERTY_SEARCHKEY
  - setSearchKey
```
public void setSearchKey(String searchKey)
```
    See Also:
    
    PROPERTY_SEARCHKEY
  - getProperty
```
public String getProperty()
```
    See Also:
    
    PROPERTY_PROPERTY
  - setProperty
```
public void setProperty(String property)
```
    See Also:
    
    PROPERTY_PROPERTY
  - isPropertyList
```
public Boolean isPropertyList()
```
    See Also:
    
    PROPERTY_PROPERTYLIST
  - setPropertyList
```
public void setPropertyList(Boolean propertyList)
```
    See Also:
    
    PROPERTY_PROPERTYLIST
  - getVisibleAtClient
```
public Client getVisibleAtClient()
```
    See Also:
    
    PROPERTY_VISIBLEATCLIENT
  - setVisibleAtClient
```
public void setVisibleAtClient(Client visibleAtClient)
```
    See Also:
    
    PROPERTY_VISIBLEATCLIENT
  - getVisibleAtOrganization
```
public Organization getVisibleAtOrganization()
```
    See Also:
    
    PROPERTY_VISIBLEATORGANIZATION
  - setVisibleAtOrganization
```
public void setVisibleAtOrganization(Organization visibleAtOrganization)
```
    See Also:
    
    PROPERTY_VISIBLEATORGANIZATION
  - getVisibleAtRole
```
public Role getVisibleAtRole()
```
    See Also:
    
    PROPERTY_VISIBLEATROLE
  - setVisibleAtRole
```
public void setVisibleAtRole(Role visibleAtRole)
```
    See Also:
    
    PROPERTY_VISIBLEATROLE
  - isSelected
```
public Boolean isSelected()
```
    See Also:
    
    PROPERTY_SELECTED
  - setSelected
```
public void setSelected(Boolean selected)
```
    See Also:
    
    PROPERTY_SELECTED
  - getModule
```
public Module getModule()
```
    See Also:
    
    PROPERTY_MODULE
  - setModule
```
public void setModule(Module module)
```
    See Also:
    
    PROPERTY_MODULE
  - getInheritedFrom
```
public Role getInheritedFrom()
```
    Specified by:
    
    getInheritedFrom in interface InheritedAccessEnabled
    
    See Also:
    
    PROPERTY_INHERITEDFROM
  - setInheritedFrom
```
public void setInheritedFrom(Role inheritedFrom)
```
    Specified by:
    
    setInheritedFrom in interface InheritedAccessEnabled
    
    See Also:
    
    PROPERTY_INHERITEDFROM

Class Preference

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

TABLE_NAME

ENTITY_NAME

PROPERTY_ID

PROPERTY_CLIENT

PROPERTY_ORGANIZATION

PROPERTY_ACTIVE

PROPERTY_CREATIONDATE

PROPERTY_CREATEDBY

PROPERTY_UPDATED

PROPERTY_UPDATEDBY

PROPERTY_WINDOW

PROPERTY_USERCONTACT

PROPERTY_ATTRIBUTE

PROPERTY_SEARCHKEY

PROPERTY_PROPERTY

PROPERTY_PROPERTYLIST

PROPERTY_VISIBLEATCLIENT

PROPERTY_VISIBLEATORGANIZATION

PROPERTY_VISIBLEATROLE

PROPERTY_SELECTED

PROPERTY_MODULE

PROPERTY_INHERITEDFROM

Constructor Detail

Preference

Method Detail

getEntityName

getId

setId

getClient

setClient

getOrganization

setOrganization

isActive

setActive

getCreationDate

setCreationDate

getCreatedBy

setCreatedBy

getUpdated

setUpdated

getUpdatedBy

setUpdatedBy

getWindow

setWindow

getUserContact

setUserContact

getAttribute

setAttribute

getSearchKey

setSearchKey

getProperty

setProperty

isPropertyList

setPropertyList

getVisibleAtClient

setVisibleAtClient

getVisibleAtOrganization

setVisibleAtOrganization

getVisibleAtRole

setVisibleAtRole

isSelected

setSelected

getModule

setModule

getInheritedFrom

setInheritedFrom