oracle.owb.foundation.property
Interface PropertyOwner

All Known Subinterfaces:

AdvancedQueue, AttributeGroup, BusinessArea, BusinessAreaShortcut, CheckConstraint, Column, Connector, Cube, Datafile, Dimension, DrillItem, DrillLevel, DrillPath, Extensible, ExternalTable, ExternalTableColumn, Field, FlatFile, FlatFileModule, ForeignKey, Function, GatewayModule, Hierarchy, Index, IndexColumn, IntelligenceModule, IOFunction, ItemClass, Join, JoinComponent, Level, LevelAttribute, Map, MapAttribute, MapAttributeGroup, MapOperator, MaterializedView, Measure, Module, ObjectAttribute, ObjectType, OracleModule, OWBCollection, Package, Parameter, Partition, PartitionKey, Procedure, ProcessActivityParameter, ProcessFlowModule, ProcessFlowPackage, Project, PurePhysicalObject, QueryItem, QueryObject, Record, Report, ReportGroup, ReportGroupShortcut, ReportItem, ReportModule, SAPModule, Sequence, Table, TransformationModule, Transition, UniqueKey, View

All Known Implementing Classes:

oracle.owb.foundation.extensible.ExtensibleImpl, PLSQLRecordAttribute, oracle.owb.foundation.property.PropertyOwnerImpl

public interface PropertyOwner

PropertyOwner interface provides definition of all valid properties and access methods.

Method Summary

java.lang.Object	getDefaultPropertyValue(java.lang.String key) Obtain the default property value given a property name.
java.lang.String[]	getLogicalPropertyKeys() Retrieves all valid logical property names.
java.lang.String[]	getPhysicalPropertyKeys() Retrieve all valid physical property names.
Domain	getPropertyDomain(java.lang.String key) Obtain the value domain definition for a property.
java.lang.String[]	getPropertyKeys() Retrieves all valid property names.
java.lang.Object	getPropertyValue(java.lang.String key) Get property value given a property name.
java.lang.String	getPropertyValueString(java.lang.String key) Get property value and convert to string format.
boolean	isLogicalProperty(java.lang.String key) Check if a given property name corresponds to a logical property.
boolean	isPhysicalProperty(java.lang.String key) Check if a given property name corresponds to a physical property.
boolean	isReadOnlyProperty(java.lang.String key) Check whether a given property is read only.
void	setPropertyValue(java.lang.String key, java.lang.Object value) Set a property value.
void	setPropertyValueByString(java.lang.String key, java.lang.String value) Set a property value converted from a string.

Method Detail

getPropertyKeys

public java.lang.String[] getPropertyKeys()

Retrieves all valid property names.

Returns:

An array of valid logical/physical property name strings

getLogicalPropertyKeys

public java.lang.String[] getLogicalPropertyKeys()

Retrieves all valid logical property names.

Returns:

An array of valid logical property name strings

getPhysicalPropertyKeys

public java.lang.String[] getPhysicalPropertyKeys()

Retrieve all valid physical property names.

Returns:

An array of valid physical property name strings

isLogicalProperty

public boolean isLogicalProperty(java.lang.String key)

Check if a given property name corresponds to a logical property.

Parameters:

key - A property name

Returns:

true if the key corresponds to a logical property; false otherwise.

isPhysicalProperty

public boolean isPhysicalProperty(java.lang.String key)

Check if a given property name corresponds to a physical property.

Parameters:

key - A property name

Returns:

true if key corresponds to a physical property; false, otherwise.

isReadOnlyProperty

public boolean isReadOnlyProperty(java.lang.String key)

Check whether a given property is read only.

Parameters:

key - A property name

Returns:

true if the property name corresponds to a property that cannot be modified; false otherwise.

getPropertyDomain

public Domain getPropertyDomain(java.lang.String key)
                         throws NoSuchPropertyException

Obtain the value domain definition for a property. A domain definition defines the min/max value, and the choices for the valies, etc.

Parameters:

key - A property name

Returns:

A PropertyDomain instance that defines the possible values this parameter value can take.

Throws:

NoSuchPropertyException

getDefaultPropertyValue

public java.lang.Object getDefaultPropertyValue(java.lang.String key)
                                         throws NoSuchPropertyException

Obtain the default property value given a property name.

Parameters:

key - A property name

Returns:

An object that holds the default value of the property.

Throws:

NoSuchPropertyException

setPropertyValue

public void setPropertyValue(java.lang.String key,
                             java.lang.Object value)
                      throws NoSuchPropertyException,
TypeMismatchException

Set a property value.

Parameters:

key - A property name

value - A property value

Throws:

NoSuchPropertyException

TypeMismatchException

See Also:

getPropertyValue(java.lang.String)

setPropertyValueByString

public void setPropertyValueByString(java.lang.String key,
                                     java.lang.String value)
                              throws NoSuchPropertyException,
TypeMismatchException

Set a property value converted from a string.

Parameters:

key - A property name

value - A string which can be converted to the type of object based on the type of the property.

Throws:

NoSuchPropertyException

TypeMismatchException

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String key)
                                  throws NoSuchPropertyException

Get property value given a property name.

Parameters:

key - A property name

Returns:

The property value for the property name.

Throws:

NoSuchPropertyException

See Also:

setPropertyValue(java.lang.String, java.lang.Object)

getPropertyValueString

public java.lang.String getPropertyValueString(java.lang.String key)
                                        throws NoSuchPropertyException,
TypeMismatchException

Get property value and convert to string format.

Parameters:

key - A property name

Returns:

the property value which is converted to string format.

Throws:

NoSuchPropertyException

TypeMismatchException