oracle.owb.flatfile
Interface Record

All Superinterfaces:

Extensible, OWBNamedObject, PropertyOwner, ReconcileSource

public interface Record

extends ReconcileSource, Extensible

Record interface represents a record.

Since:

9.0.4

Version:

9.0.4

Author:

Luda Mogilevich (lyudmila.mogilevich@oracle.com)

Method Summary

Field	createField(java.lang.String name) Creates a new Field and adds it to the Record.
Field	createField(java.lang.String name, int position) Creates a new Field and adds it to the Record at the specified position.
Field	findField(java.lang.String name) Finds a Field in the Record.
Field[]	getFields() Gets all the Fields of the Record.
FlatFile	getOwningFlatFile() Returns the FlatFile which contains the Record.
java.lang.String	getRecordTypeValue() Gets the record type value(s) for the Record; the value(s) which distinguish the Record from the other Records in the datafile
void	moveField(Field field, int newPosition) Moves a Field of the Record to the new position.
void	setRecordTypeValue(java.lang.String value) Sets the record type value(s) for the Record; the value(s) which distinguish the Record from the other Records in the datafile.

Methods inherited from interface oracle.owb.reconcile.ReconcileSource

getReconcileTargetTypes, getType

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName

Methods inherited from interface oracle.owb.foundation.property.PropertyOwner

getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString

Method Detail

getOwningFlatFile

public FlatFile getOwningFlatFile()

Returns the FlatFile which contains the Record.

Returns:

the parent FlatFile

createField

public Field createField(java.lang.String name)
                  throws NameSpaceException,
InvalidFormatException

Creates a new Field and adds it to the Record.

Parameters:

name - a String which will be the name of the new Field. The name will be converted to all uppercase characters if it is not already.

Returns:

the Field created by this method

Throws:

NameSpaceException - If the name has already been used by a Field in this Record

InvalidFormatException - If the name is not a valid name for a Field object. For example, it is too long or contains invalid characters.

createField

public Field createField(java.lang.String name,
                         int position)
                  throws NameSpaceException,
InvalidFormatException

Creates a new Field and adds it to the Record at the specified position.

Parameters:

name - a String which will be the name of the new Field. The name will be converted to all uppercase characters if it is not already.

position - where this newly created Field will be located in this Record

Returns:

the Field created by this method

Throws:

NameSpaceException - If the name has already been used by a Field in this Record

InvalidFormatException - If the name is not a valid name for a Field object. For example, it is too long or contains invalid characters.

getFields

public Field[] getFields()

Gets all the Fields of the Record.

Returns:

an array of this Record's Fields

findField

public Field findField(java.lang.String name)

Finds a Field in the Record.

Parameters:

name - a String specifying the name of the Field to find. It is case sensitive.

Returns:

the Field found; or null if no Field exists of the given name

moveField

public void moveField(Field field,
                      int newPosition)

Moves a Field of the Record to the new position.

Parameters:

field - the Field to move

newPosition - where the Field will be located in this Record

setRecordTypeValue

public void setRecordTypeValue(java.lang.String value)

Sets the record type value(s) for the Record; the value(s) which distinguish the Record from the other Records in the datafile.

Parameters:

value - the record type value. Assign multiple record type values to the Record by passing in a comma delimited String.

See Also:

getRecordTypeValue

getRecordTypeValue

public java.lang.String getRecordTypeValue()

Gets the record type value(s) for the Record; the value(s) which distinguish the Record from the other Records in the datafile

Returns:

the record type value. Returns multiple values as a comma delimited String.

See Also:

setRecordTypeValue