RelationFieldInfo (SmartClient Enterprise Server API 14.0d (2024-11-01))

java.lang.Object
- com.isomorphic.datasource.RelationFieldInfo

public class RelationFieldInfo
extends java.lang.Object

Holds information about relation field.

Constructor Summary

Constructors
Constructor and Description
`RelationFieldInfo(java.lang.String fieldName, java.lang.String type, java.lang.String relatedDSName, java.lang.String relatedFieldName, boolean objectEncapsulated, boolean multiple)` Creates information about relation field.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getFieldName()` Returns field name as declared in data source.
`java.lang.String`	`getRelatedDSName()` Returns related data source name.
`java.lang.String`	`getRelatedFieldName()` Returns field name in related data source.
`java.lang.String`	`getType()` Returns field type as declared in data source.
`boolean`	`isMultiple()` Returns `true` if field holds list of objects or list of primary keys of related objects; `flase` if field holds realted object or primary key of related object.
`boolean`	`isObjectEncapsulated()` Returns `true` if field encapsulates object or list of objects; `flase` if field holds primary key of related object or list of primary keys of related objects.

- Constructor Detail
  - RelationFieldInfo
```
public RelationFieldInfo(java.lang.String fieldName,
                         java.lang.String type,
                         java.lang.String relatedDSName,
                         java.lang.String relatedFieldName,
                         boolean objectEncapsulated,
                         boolean multiple)
```
    Creates information about relation field.
    
    Parameters:
    
    fieldName - String Field name.
    
    type - String Field type.
    
    relatedDSName - String Related data source name.
    
    relatedFieldName - String Field name in related data source.
    
    objectEncapsulated - boolean Should field encapsulate object or hold primary key reference.
    
    multiple - boolean Should field contain list of related objects or refers to single object.
- Method Detail
  - getFieldName
```
public java.lang.String getFieldName()
```
    Returns field name as declared in data source.
    
    Returns:
    
    String Field name.
  - getType
```
public java.lang.String getType()
```
    Returns field type as declared in data source.
    
    Returns:
    
    String Field type.
  - getRelatedDSName
```
public java.lang.String getRelatedDSName()
```
    Returns related data source name.
    
    Returns:
    
    String Related data source name.
  - getRelatedFieldName
```
public java.lang.String getRelatedFieldName()
```
    Returns field name in related data source.
    
    Returns:
    
    String Field name in related data source.
  - isObjectEncapsulated
```
public boolean isObjectEncapsulated()
```
    Returns true if field encapsulates object or list of objects; flase if field holds primary key of related object or list of primary keys of related objects.
    
    Returns:
    
    boolean true if field encapsulates object or list of objects; flase if field holds primary key of related object or list of primary keys of related objects.
  - isMultiple
```
public boolean isMultiple()
```
    Returns true if field holds list of objects or list of primary keys of related objects; flase if field holds realted object or primary key of related object.
    
    Returns:
    
    boolean true if field holds list of objects or list of primary keys of related objects; flase if field holds realted object or primary key of related object.

Class RelationFieldInfo

Constructor Summary

Method Summary

Constructor Detail

RelationFieldInfo

Method Detail

getFieldName

getType

getRelatedDSName

getRelatedFieldName

isObjectEncapsulated

isMultiple