oracle.owb.foundation
Interface OWBNamedObject

All Known Subinterfaces:

AbstractDatatype, Activity, AdvancedQueue, AssociationDefinition, AtomicDerivationSource, Attribute, AttributeGroup, AttributeGroupOwner, BaseLocation, BaseProcess, BusinessArea, BusinessAreaShortcut, CheckConstraint, ClassDefinition, CollectiveDerivationSource, Column, ColumnOwner, Component, Connector, Cube, CubeDimensionUse, Datafile, Datatype, Datatyped, DatatypeSet, Dimension, Domain, Domain, DrillItem, DrillLevel, DrillPath, EnumerationDomain, ExternalTable, ExternalTableColumn, Field, FlatFile, FlatFileModule, Folder, ForeignKey, Function, GatewayModule, Hierarchy, Index, IndexColumn, IndexPartitionOwner, IntelligenceModule, IntelligenceObject, IODerivationSource, IODerivationTarget, IOFunction, ItemClass, Join, JoinComponent, KeyOwner, Language, Level, LevelAttribute, LevelIdentifier, ListDatatype, Location, Map, MapAttribute, MapAttributeGroup, MapDatatypeSet, MapOperator, MappingPropertyDatatypeSet, MaterializedView, Measure, Module, ObjectAttribute, ObjectType, OracleDatatypeSet, OracleModule, OWBCollection, Package, Parameter, Partition, PartitionKey, PLSQLDatatypeSet, PrimitiveType, Procedure, ProcessActivityParameter, ProcessActivityParameterOwner, ProcessData, ProcessDatatypeSet, ProcessFlow, ProcessFlowModule, ProcessFlowPackage, Project, PropertyDefinition, PurePhysicalObject, QueryItem, QueryObject, RangeDomain, ReconcileSource, ReconcileTarget, Record, ReferenceType, Report, ReportGroup, ReportGroupShortcut, ReportItem, ReportModule, RoleDefinition, RuntimeRepository, SAPDatatypeSet, SAPModule, ScalarDatatype, ScalarType, ScalarValue, Sequence, SQLLoaderDatatypeSet, SubProcess, Table, Transformation, TransformationModule, Transition, Type, UniqueKey, Value, View

All Known Implementing Classes:

oracle.owb.foundation.type.DatatypedImpl, oracle.owb.foundation.OWBNamedObjectImpl, PLSQLRecordAttribute

public interface OWBNamedObject

This is the base interface for all OWB metadata objects exposed in the public API. It provides basic properties like name, business name and description. It always has a unique global identifier (UOID). A generic delete() method is provided at this level and inherited by all other objects. Deleting an OWB object will result in removing it from the repository, as well as from the Java object cache. Any further attempt to access the object will result in OWBException runtime exception being thrown.

Method Summary

void	delete() Deletes the object.
java.lang.String	getBusinessName() Gets this object's business name.
ClassDefinition	getClassDefinition() Returns the class definition for this object.
Component	getComponent() Returns the owning Component for this object.
java.lang.String	getDescription() Gets this object's detailed description.
java.lang.String	getName() Gets this object's name.
java.lang.String	getUOID() Returns the unique identifier of this object.
boolean	isDeletable() Returns whether this object is deletable.
boolean	isEditable() Returns whether this object is editable.
boolean	isRenamable() Returns whether this object is renamable.
void	setBusinessName(java.lang.String businessName) Sets the business name for this object.
void	setDescription(java.lang.String description) Sets a detailed description for this object.
void	setName(java.lang.String name) Sets the name for this object.

Method Detail

getUOID

public java.lang.String getUOID()

Returns the unique identifier of this object. An unique identifier is assigned for each object at creation time.

Returns:

the unique identifier for this object.

getName

public java.lang.String getName()

Gets this object's name.

Returns:

the object's name

See Also:

setName(java.lang.String)

setName

public void setName(java.lang.String name)
             throws NameSpaceException,
InvalidFormatException

Sets the name for this object. The name must comply with the following restrictions:

• The name must not be null, and its length must be greater than 0 and less or equal to 30 charaters.
• It must not contain space or illegal characters, as defined in Oracle Database documentation.
• It must not be any of the SQL or PL/SQL reserved words, as defined in Oracle Database documentation.
• It must start with a letter.
• It must not start with prefix "OWB$", which is reserved for OWB generated names.

Parameters:

name - the name for this object

Throws:

NameSpaceException - if another OWBNamedObject with the same name already exists within this object's namespace

InvalidFormatException - if the desired name does not satisfy the format requirements

See Also:

getName()

getBusinessName

public java.lang.String getBusinessName()

Gets this object's business name.

Returns:

the object's business name

See Also:

setBusinessName(java.lang.String)

setBusinessName

public void setBusinessName(java.lang.String businessName)
                     throws NameSpaceException,
InvalidFormatException

Sets the business name for this object. The business name must not be null, and its length must be greater than 0 and less or equal to 255 charaters.

Parameters:

businessName - the business name for this object

Throws:

NameSpaceException - if another OWBNamedObject with the same business name already exists within this object's namespace

InvalidFormatException - if the desired business name does not satisfy the format requirements

See Also:

getBusinessName()

getDescription

public java.lang.String getDescription()

Gets this object's detailed description.

Returns:

the object's description

See Also:

setDescription(java.lang.String)

setDescription

public void setDescription(java.lang.String description)

Sets a detailed description for this object.

Parameters:

description - the object's description

See Also:

getDescription()

delete

public void delete()

Deletes the object. Deleting an OWB object will result in removing it from the repository (if commited), as well as from the Java object cache. Any further attempt to access the object will result in OWBException runtime exception being thrown. One should not use the reference to a deleted object anymore, not even in cases when the object has been restored (by rollback, etc.), but rather obtain a new reference to it.

getComponent

public Component getComponent()

Returns the owning Component for this object. If the object is not part of any component, the method returns null.

Returns:

the owning component, or null if this object is not part of any component

getClassDefinition

public ClassDefinition getClassDefinition()

Returns the class definition for this object.

Returns:

the class definition for this object

isEditable

public boolean isEditable()

Returns whether this object is editable.

Returns:

true if the object is editable, and false otherwise

isRenamable

public boolean isRenamable()

Returns whether this object is renamable.

Returns:

true if the object is renamable, and false otherwise

isDeletable

public boolean isDeletable()

Returns whether this object is deletable.

Returns:

true if the object is deletable, and false otherwise