com.sap.dictionary.runtime

Interface IField

public interface IField

Method Summary

boolean	belongsToAppend() Returns if this field is contained in an Append.
IDataType	getDataType() Returns the data type used in the given field.
IDataType	getDataType(IBroker broker) Returns the data type used in the given field.
String	getName() Returns the field's name
IField	getReferenceField() Returns the reference field of a given field.
IField	getReferenceField(IBroker broker) Returns the reference field of a given field.
IStructure	getStructure() Returns the structure which contains this field
boolean	hasReferenceField() Returns wether the field has a reference field
boolean	isCustomerExtension() Returns if this field is contained in an Append or a Ci/Si-Include.
boolean	isScalar() Returns wether this field is a scalar field.
String	toString() Returns a String representation of the field

Method Detail

getName

public String getName()

Returns the field's name

getStructure

public IStructure getStructure()

Returns the structure which contains this field

getDataType

public IDataType getDataType(IBroker broker)
                      throws DdException

Returns the data type used in the given field. This can be an ISimpleType.

Parameters:

broker - - the broker to ask for the data type

Returns:

a dataType

Throws:

DdException - - if dataType with given name not found

getDataType

public IDataType getDataType()
                      throws DdException

Returns the data type used in the given field. This can be an ISimpleType.

Returns:

a dataType

Throws:

DdException - - if dataType with given name not found

hasReferenceField

public boolean hasReferenceField()

Returns wether the field has a reference field

Returns:

true, if field has a reference field, false otherwise

getReferenceField

public IField getReferenceField(IBroker broker)
                         throws DdException

Returns the reference field of a given field.

Parameters:

broker - - the broker to ask for the data type

Returns:

a field

Throws:

DdException - - if reference field could not be found

getReferenceField

public IField getReferenceField()
                         throws DdException

Returns the reference field of a given field.

Returns:

a field

Throws:

DdException - - if reference field could not be found

isCustomerExtension

public boolean isCustomerExtension()

Returns if this field is contained in an Append or a Ci/Si-Include. This method can only return true, if the backend system is a R/3-system.

Returns:

true if field is contained in an Append, false otherwise

belongsToAppend

public boolean belongsToAppend()

Returns if this field is contained in an Append. This method can only return true, if the backend system is a R/3-system.

Returns:

true if field is contained in an Append, false otherwise

isScalar

public boolean isScalar()

Returns wether this field is a scalar field. A field is scalar, if it can be typed by a SimpleType

Returns:

true if field is scalar, false otherwise

toString

public String toString()

Returns a String representation of the field