ilog.ds
Interface IlDataSourceEditor

All Known Subinterfaces:
IlGanttDataSourceEditor, IlGraphDataSourceEditor, IlListDataSourceEditor, IlSDMDataSourceEditor, IlTableDataSourceEditor, IlTreeDataSourceEditor
All Known Implementing Classes:
IlsDataSource

public interface IlDataSourceEditor

Interface for editing data source properties and managing batch updates to the back-end . Note that the execution of all methods prefixed with ds may be asynchronous and, therefore, may not be immediately reflected in the local model.


Method Summary
abstract  void dsEndBatch()
          Notifies the data source that the updates are finished and can be sent to the back-end .
abstract  void dsStartBatch()
          Notifies the data source that some updates will take place.
abstract  void dsUpdateProperty(String name, Object value)
          Requests the back-end to update a data source property.
abstract  int getDSBatchLevel()
          Gets the level to which outgoing batches are currently nested.
abstract  boolean isEditable()
          Finds out whether the data source is editable or not.
 

Method Detail

isEditable

public boolean isEditable()
Finds out whether the data source is editable or not.
Returns:
false if the data source is read-only.

dsUpdateProperty

public void dsUpdateProperty(String name,
                             Object value)
Requests the back-end to update a data source property.
Parameters:
name - The name of the property
value - The new value of the property

dsStartBatch

public void dsStartBatch()
Notifies the data source that some updates will take place. The updates will not be sent until #dsEndBatch is called. The function beginEditing may be called several times without calling dsEndBatch. If so, the batches of updates will be nested and will not be sent before dsEndBatch is called an equal number of times, i.e. the batch level drops to zero.

getDSBatchLevel

public int getDSBatchLevel()
Gets the level to which outgoing batches are currently nested.
Returns:
The number of nested batches

dsEndBatch

public void dsEndBatch()
Notifies the data source that the updates are finished and can be sent to the back-end .