| Package | flex.data.config |
| Class | public class AssociationSetting |
| Inheritance | AssociationSetting  Object |
AssociationSetting class is used to add association properties to DataDestination types.| Method | Defined By | ||
|---|---|---|---|
AssociationSetting(String relationString, String property, String destination) Creates an AssociationSetting instance with indicated settings and default lazy, sequenced, readOnly and cacheReferencedItems settings. | AssociationSetting | ||
AssociationSetting(String relationString, String property, String destination, boolean lazy, boolean sequenced, boolean readOnly) Creates an AssociationSetting instance with indicated settings. | AssociationSetting | ||
AssociationSetting(String relationString, String property, String destination, boolean lazy, boolean sequenced, boolean readOnly, boolean cacheReferencedItems) Creates an AssociationSetting instance with indicated settings. | AssociationSetting | ||
boolean getCacheReferencedItems() Returns the cache referenced items property. | AssociationSetting | ||
String getDestination() Returns the destination of the association. | AssociationSetting | ||
boolean getHierarchicalEvents() Set this to true for association properties where the parent should receive property change events even for properties of children of the association. | AssociationSetting | ||
boolean getLazy() Returns if the association is lazy. | AssociationSetting | ||
int getPageSize() When the association value is paged, this controls the page size to use. | AssociationSetting | ||
String getProperty() Returns the property of the association. | AssociationSetting | ||
int getProxyIndex() | AssociationSetting | ||
boolean getReadOnly() Returns the read-only property. | AssociationSetting | ||
int getRelation() Returns the relation of the association. | AssociationSetting | ||
String getRelationString() Returns the string representation of the relation of the association. | AssociationSetting | ||
boolean getSequenced() Returns the sequenced property. | AssociationSetting | ||
boolean isLoadOnDemand() Set to true for properties which are not sent to the client for the initial fill or getItem call. | AssociationSetting | ||
boolean isMulti() Returns true if this is a multi-values association. | AssociationSetting | ||
boolean isOrdered() Returns true if the order of this association property is important. | AssociationSetting | ||
boolean isPagedCollection() When paging is enabled for this association, should we use the getPagedCollection Assembler methods to retrieve the value (i.e. | AssociationSetting | ||
boolean isPagedUpdates() For multi-valued associations, if you want updates to be processed incrementally (i.e. | AssociationSetting | ||
void setCacheReferencedItems(boolean cacheReferencedItems) Sets the cache referenced items property. | AssociationSetting | ||
void setHierarchicalEvents(boolean he) | AssociationSetting | ||
void setLazy(boolean lazy) Sets the lazy property. | AssociationSetting | ||
void setLoadOnDemand(boolean lod) | AssociationSetting | ||
void setOrdered(boolean ordered) Set this to true for association properties whose order is important. | AssociationSetting | ||
void setPagedCollection(boolean pc) | AssociationSetting | ||
void setPagedUpdates(boolean pu) | AssociationSetting | ||
void setPageSize(int ps) | AssociationSetting | ||
void setProxyIndex(int pi) | AssociationSetting | ||
void setReadOnly(boolean readOnly) Sets the read-only property. | AssociationSetting | ||
void setSequenced(boolean sd) Sets the sequenced property. | AssociationSetting | ||
| AssociationSetting | () |
public AssociationSetting(String relationString, String property, String destination)Creates an AssociationSetting instance with indicated settings and default lazy, sequenced, readOnly and cacheReferencedItems settings.
relationString — Valid options are one-to-one, one-to-many, many-to-one, many-to-many. | |
property — the name of the property which holds this association | |
destination — the destination that manages the values of this association |
| AssociationSetting | () |
public AssociationSetting(String relationString, String property, String destination, boolean lazy, boolean sequenced, boolean readOnly)Creates an AssociationSetting instance with indicated settings.
relationString — Valid options are one-to-one, one-to-many, many-to-one, many-to-many. | |
property — the name of the property which holds this association | |
destination — the destination that manages the values of this association | |
lazy — set this to true if your property should be sent to the client only when explicitly requested. Requires that the referenced destination implement the getItem method. | |
sequenced — set this to true if you want the autoSync feature to be able to check for changes to references to nested items for this property. | |
readOnly — set this to true if the referencing item is not dependent on the values of this property for persisting. When you use bi-directional associations the inverse side should set readOnly to true so that we ensure objects in a nested graph are created in the proper order. |
| AssociationSetting | () |
public AssociationSetting(String relationString, String property, String destination, boolean lazy, boolean sequenced, boolean readOnly, boolean cacheReferencedItems)Creates an AssociationSetting instance with indicated settings. Use this variant if you want to override the default of the cacheReferencedItems setting.
relationString — Valid options are one-to-one, one-to-many, many-to-one, many-to-many. | |
property — the name of the property which holds this association | |
destination — the destination that manages the values of this association | |
lazy — set this to true if your property should be sent to the client only when explicitly requested. Requires that the referenced destination implement the getItem method. | |
sequenced — set this to true if you want the autoSync feature to be able to check for changes to references to nested items for this property. | |
readOnly — set this to true if the referencing item is not dependent on the values of this property for persisting. When you use bi-directional associations the inverse side should set readOnly to true so that we ensure objects in a nested graph are created in the proper order. | |
cacheReferencedItems — if you set lazy to true, you usually set this to false. When cacheReferencedItems is false, the assembler returns hollow objects with only the ids properties populated. If you set this to true, the assembler must return complete versions of the objects which are then cached in the item cache. If the referenced item's destination has cache-items false, this setting has no effect. |
| getCacheReferencedItems | () |
public boolean getCacheReferencedItems()Returns the cache referenced items property. If this is true, the values returned by this association are added to the item cache (assuming that the referenced destination's cache-items property is enabled). Usually this is false for associations with lazy=true so that the assembler can return hollow references to the associated objects. There might be some situations where you want the client to lazily fetch the values but you do not want to fetch items from the assembler when that happens and instead want to rely on the item cache to hold the referenced items. In that case, you can override the default and set this to true even if lazy=true.
Returnstrue if cache referenced items is enabled; otherwise false. |
| getDestination | () |
public String getDestination()Returns the destination of the association.
Returns| the destination of the association |
| getHierarchicalEvents | () |
public boolean getHierarchicalEvents()Set this to true for association properties where the parent should receive property change events even for properties of children of the association.
Returns| getLazy | () |
public boolean getLazy()Returns if the association is lazy.
Returnstrue if the association is lazy; otherwise false. |
| getPageSize | () |
public int getPageSize()When the association value is paged, this controls the page size to use.
Returns| getProperty | () |
public String getProperty()Returns the property of the association.
Returns| the property of the association |
| getProxyIndex | () |
public int getProxyIndex()Returns| getReadOnly | () |
public boolean getReadOnly()Returns the read-only property.
Returnstrue if association is read-only; otherwise false. |
| getRelation | () |
public int getRelation()Returns the relation of the association.
Returns| the relation of the association |
| getRelationString | () |
public String getRelationString()Returns the string representation of the relation of the association.
Returns| String representation of the relation. |
| getSequenced | () |
public boolean getSequenced()Returns the sequenced property.
Returnstrue if association is sequenced; otherwise false. |
| isLoadOnDemand | () |
public boolean isLoadOnDemand()Set to true for properties which are not sent to the client for the initial fill or getItem call. Instead, they are fetched lazily when they are accessed.
Returns| isMulti | () |
public boolean isMulti()Returns true if this is a multi-values association.
| isOrdered | () |
public boolean isOrdered()Returns true if the order of this association property is important.
Returns| isPagedCollection | () |
public boolean isPagedCollection()When paging is enabled for this association, should we use the getPagedCollection Assembler methods to retrieve the value (i.e. a page at a time rather than fetching the entire collection and only paging it to the client).
Returns| isPagedUpdates | () |
public boolean isPagedUpdates()For multi-valued associations, if you want updates to be processed incrementally (i.e. using explicit add/remove calls) rather than sending the entire value set this to true.
Returns| setCacheReferencedItems | () |
public void setCacheReferencedItems(boolean cacheReferencedItems)Sets the cache referenced items property. Default is true.
Parameters
cacheReferencedItems |
| setHierarchicalEvents | () |
public void setHierarchicalEvents(boolean he)Parameters
he |
| setLazy | () |
public void setLazy(boolean lazy)Sets the lazy property. Default is false.
Parameters
lazy |
| setLoadOnDemand | () |
public void setLoadOnDemand(boolean lod)Parameters
lod |
| setOrdered | () |
public void setOrdered(boolean ordered)Set this to true for association properties whose order is important. The default value is true.
Parameters
ordered |
| setPagedCollection | () |
public void setPagedCollection(boolean pc)Parameters
pc |
| setPagedUpdates | () |
public void setPagedUpdates(boolean pu)Parameters
pu |
| setPageSize | () |
public void setPageSize(int ps)Parameters
ps |
| setProxyIndex | () |
public void setProxyIndex(int pi)Parameters
pi |
| setReadOnly | () |
public void setReadOnly(boolean readOnly)Sets the read-only property. Default is false.
Parameters
readOnly |
| setSequenced | () |
public void setSequenced(boolean sd)Sets the sequenced property. Default is true.
Parameters
sd |
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/flex/data/config/AssociationSetting.html