oracle.owb.flatfile
Interface FlatFileModule

All Superinterfaces:

Component, Extensible, Folder, Module, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface FlatFileModule

extends Module

FlatFileModule is a specialized Module which can contain FlatFiles.

Since:

9.0.4

Version:

9.0.4

Author:

Luda Mogilevich (lyudmila.mogilevich@oracle.com)

Fields inherited from interface oracle.owb.data.Module

MODULE_FLATFILE, MODULE_GATEWAY_DB2, MODULE_GATEWAY_DRDA, MODULE_GATEWAY_INFORMIX, MODULE_GATEWAY_ODBC, MODULE_GATEWAY_OTHER, MODULE_GATEWAY_RDB, MODULE_GATEWAY_SQLSERVER, MODULE_GATEWAY_SYBASE, MODULE_GATEWAY_TERRADATA, MODULE_ORACLE, MODULE_ORACLE_APPS, MODULE_PROCESS_FLOW, MODULE_SAP

Fields inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

FlatFile	createFlatFile(java.lang.String name) Creates a new FlatFile and adds it to the FlatFileModule.
FlatFile	findFlatFile(java.lang.String name) Finds a FlatFile in the FlatFileModule.
java.lang.String[]	getFlatFileNames() Returns a list of FlatFile names.

Methods inherited from interface oracle.owb.data.Module

getDatatypeSet, getLocation, getProject, setLocation

Methods inherited from interface oracle.owb.foundation.Folder

findChild, getContentTypes, getFolderContents, getFolderContentsOfType, isCascadeForSnapshot, lockShared, lockWithContents, reloadWithContents, setCascadeForSnapshot

Methods inherited from interface oracle.owb.foundation.Component

getOwningFolder, isReloadNeeded, lock, reload, unlock

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.metadatamgmt.changemgmt.Snapshotable

compare, compare, compare, compare, createSnapshot, createSnapshot, createSnapshotWithDependeeComponents, createSnapshotWithDependeeComponents, getSnapshots

Methods inherited from interface oracle.owb.compile.ValidatableObject

validate

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

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

Method Detail

getFlatFileNames

public java.lang.String[] getFlatFileNames()

Returns a list of FlatFile names.

Returns:

an array of String objects representing the names of all of the FlatFiles owned by this Module

createFlatFile

public FlatFile createFlatFile(java.lang.String name)
                        throws NameSpaceException,
                               InvalidFormatException

Creates a new FlatFile and adds it to the FlatFileModule.

Parameters:

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

Returns:

the FlatFile created by this method

Throws:

NameSpaceException - If the name has already been used by a FlatFile in this FlatFileModule

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

findFlatFile

public FlatFile findFlatFile(java.lang.String name)

Finds a FlatFile in the FlatFileModule.

Parameters:

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

Returns:

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