public interface DataRelationInterface
Modifier and Type | Method and Description |
---|---|
handle |
getChildBuffer()
Obtain the buffer handle of the child member of this data-relation object.
|
handle |
getCurrentQuery()
Obtain the handle to the
DataSet query that contains the currently selected row in
the BindingSource . |
handle |
getCurrentQuery(long bandIndex)
Obtain the handle to the
DataSet query that contains the currently selected row in
the BindingSource . |
handle |
getCurrentQuery(NumberType bandIndex)
Obtain the handle to the
DataSet query that contains the currently selected row in
the BindingSource . |
logical |
getForeignKeyHidden()
Checks whether the foreign key fields in the child records of a nested data-relation are
hidden.
|
integer |
getMaximumLevel()
Obtain the maximum level where a recursive data-relation stops.
|
handle |
getParentBuffer()
Obtain the buffer handle of the parent member.
|
character |
getParentFieldsAfter()
Obtain a comma-separated list of fields from the parent record in the relation to be
written to XML after all nested child records.
|
character |
getParentFieldsBefore()
Obtain a comma-separated list of fields from the parent record in the relation to be
written to XML before any nested child records.
|
character |
getRelationFields()
Obtains a comma-separated list of parent-field, child-field pairs describing the
relationship between parent and child buffers as specified in the data-relation object
definition.
|
logical |
getReposition()
Obtain the reposition mode of this data-relation object.
|
character |
getWhereString()
Obtains the current WHERE expression from the query generated that links the child table to
its parent.
|
logical |
isActive()
Corresponds to
ACTIVE ABL attribute. |
logical |
isNested()
Checks whether child rows of a
DataSet temp-table buffer are nested within their
parent rows when writing the XML representation of DataSet object that contains
data-relations. |
logical |
isParentIdRelation()
Checks whether the relationship between parent and child records is based on the
RECID type of the parent record. |
logical |
isRecursive()
Checks whether this data-relation is recursive.
|
void |
setActive(boolean active)
Corresponds to
ACTIVE ABL attribute. |
void |
setActive(logical active)
Corresponds to
ACTIVE ABL attribute. |
void |
setForeignKeyHidden(boolean hide)
Configures whether the foreign key fields in the child records of a nested data-relation are
hidden.
|
void |
setForeignKeyHidden(logical hide)
Configures whether the foreign key fields in the child records of a nested data-relation are
hidden.
|
void |
setMaximumLevel(long max)
Configures the maximum level where a recursive data-relation stops.
|
void |
setMaximumLevel(NumberType max)
Configures the maximum level where a recursive data-relation stops.
|
void |
setNested(boolean nested)
Configures whether child rows of a
DataSet temp-table buffer are nested within their
parent rows when writing the XML representation of DataSet object that contains
data-relations. |
void |
setNested(logical nested)
Configures whether child rows of a
DataSet temp-table buffer are nested within their
parent rows when writing the XML representation of DataSet object that contains
data-relations. |
void |
setReposition(boolean reposition)
Sets the reposition mode of this data-relation object.
|
void |
setReposition(logical reposition)
Sets the reposition mode of this data-relation object.
|
void |
setWhereString(java.lang.String where)
Modifies the current WHERE expression that links the child table to its parent.
|
void |
setWhereString(Text where)
Modifies the current WHERE expression that links the child table to its parent.
|
logical isActive()
ACTIVE
ABL attribute. Deactivate an individual data-relation in a
DataSet
object.ACTIVE
attribute.void setActive(boolean active)
ACTIVE
ABL attribute. Deactivate an individual data-relation in a
DataSet
object.active
- The new state of ACTIVE
attribute.void setActive(logical active)
ACTIVE
ABL attribute. Deactivate an individual data-relation in a
DataSet
object.active
- The new state of ACTIVE
attribute.handle getChildBuffer()
CHILD-BUFFER
attribute.handle getCurrentQuery()
DataSet
query that contains the currently selected row in
the BindingSource
. Corresponds to CURRENT-QUERY
ABL method.DataSet
query that contains the currently selected rowhandle getCurrentQuery(long bandIndex)
DataSet
query that contains the currently selected row in
the BindingSource
. Corresponds to CURRENT-QUERY
ABL method.bandIndex
- 0-based integer value that specifies the band index in a hierarchical gridDataSet
query that contains the currently selected rowhandle getCurrentQuery(NumberType bandIndex)
DataSet
query that contains the currently selected row in
the BindingSource
. Corresponds to CURRENT-QUERY
ABL method.bandIndex
- 0-based integer value that specifies the band index in a hierarchical gridDataSet
query that contains the currently selected rowcharacter getRelationFields()
RELATION-FIELDS
readonly ABL attribute.character getWhereString()
WHERE-STRING
attribute.void setWhereString(java.lang.String where)
WHERE-STRING
ABL attribute.where
- the new predicate.void setWhereString(Text where)
WHERE-STRING
ABL attribute.where
- the new predicate.logical getForeignKeyHidden()
FOREIGN-KEY-HIDDEN
attribute.FOREIGN-KEY-HIDDEN
attribute for this relation.void setForeignKeyHidden(boolean hide)
FOREIGN-KEY-HIDDEN
attribute.hide
- the new value value of FOREIGN-KEY-HIDDEN
attribute of this relation.void setForeignKeyHidden(logical hide)
FOREIGN-KEY-HIDDEN
attribute.hide
- the new value value of FOREIGN-KEY-HIDDEN
attribute of this relation.integer getMaximumLevel()
MAXIMUM-LEVEL
ABL attribute.void setMaximumLevel(NumberType max)
MAXIMUM-LEVEL
ABL attribute.max
- the new number of iterations at which the recursion stops.void setMaximumLevel(long max)
MAXIMUM-LEVEL
ABL attribute.max
- the new number of iterations at which the recursion stops.logical getReposition()
true
, the relation
mode is REPOSITION
. Otherwise, the relation mode is SELECTION
. The default
value is false
. This is the getter of the REPOSITION
attribute.true
when the reposition mode is REPOSITION
and false
when reposition mode is SELECTION
.void setReposition(logical reposition)
true
to set the relation
mode to REPOSITION
and false
to set it to SELECTION
. This is the
setter of the REPOSITION
attribute.reposition
- the new reposition mode as described above.void setReposition(boolean reposition)
true
to set the relation
mode to REPOSITION
and false
to set it to SELECTION
. This is the
setter of the REPOSITION
attribute.reposition
- the new reposition mode as described above.character getParentFieldsAfter()
character getParentFieldsBefore()
handle getParentBuffer()
PARENT-BUFFER
ABL read-only attributelogical isNested()
DataSet
temp-table buffer are nested within their
parent rows when writing the XML representation of DataSet
object that contains
data-relations.yes
if the child rows are nested within their parent rows.void setNested(boolean nested)
DataSet
temp-table buffer are nested within their
parent rows when writing the XML representation of DataSet
object that contains
data-relations.nested
- The new value of the NESTED
attribute.void setNested(logical nested)
DataSet
temp-table buffer are nested within their
parent rows when writing the XML representation of DataSet
object that contains
data-relations.nested
- The new value of the NESTED
attribute.logical isRecursive()
yes
when this data-relation is recursive.logical isParentIdRelation()
RECID
type of the parent record. In a PARENT-ID-RELATION
, the value of
RELATION-FIELDS
attribute will be the name of the child buffer’s RECID
field.YES
if this is a PARENT-ID-RELATION