org.eclipse.datatools.connectivity.oda.design
Interface Property


public interface Property

The property of a data design component.

The following features are supported:

See Also:
DesignPackage.getProperty()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 PropertyAttributes getDesignAttributes()
          Returns the value of the 'Design Attributes' containment reference.
 java.lang.String getName()
          Returns the name of the 'Name Value' containment reference.
 NameValuePair getNameValue()
          Returns the value of the 'Name Value' containment reference.
 java.lang.String getValue()
          Returns the value of the 'Name Value' containment reference.
 boolean isEditable()
          A convenience method to indicate whether this property value is editable or read-only in a host designer.
 boolean isMaskedValue()
          A convenience method to indicate whether the property's input value should be masked or encrypted in persistent store and any UI display.
 void setDesignAttributes(PropertyAttributes value)
          Sets the value of the 'Design Attributes' containment reference.
 void setNameValue(NameValuePair value)
          Sets the value of the 'Name Value' containment reference.
 void setNameValue(java.lang.String name, java.lang.String value)
          Sets the value of the 'Name Value' containment reference with the pair values.
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Returns the name of the 'Name Value' containment reference.

Returns:
the property name, or null if none is specified
See Also:
getNameValue()

getValue

java.lang.String getValue()
Returns the value of the 'Name Value' containment reference.

Returns:
the property value, or null if none is specified
See Also:
getNameValue()

getNameValue

NameValuePair getNameValue()
Returns the value of the 'Name Value' containment reference. Property name and corresponding value if available. The property value must be a string. The value may be selected from one of the value choices defined for a property.

Returns:
the value of the 'Name Value' containment reference.
See Also:
setNameValue(NameValuePair), DesignPackage.getProperty_NameValue()

setNameValue

void setNameValue(NameValuePair value)
Sets the value of the 'Name Value' containment reference.

Parameters:
value - the new value of the 'Name Value' containment reference.
See Also:
getNameValue()

setNameValue

void setNameValue(java.lang.String name,
                  java.lang.String value)
Sets the value of the 'Name Value' containment reference with the pair values.

Parameters:
name -
value -
See Also:
setNameValue(NameValuePair)

getDesignAttributes

PropertyAttributes getDesignAttributes()
Returns the value of the 'Design Attributes' containment reference. Property attributes defined for this *instance* of DataAccessDesign. This set of attributes overrides all those pre-defined by an ODA extension in its plugin.xml. An ODA host designer should apply those pre-defined attributes by default to this instance, only if none is specified here.

Returns:
the value of the 'Design Attributes' containment reference.
See Also:
setDesignAttributes(PropertyAttributes), DesignPackage.getProperty_DesignAttributes()

setDesignAttributes

void setDesignAttributes(PropertyAttributes value)
Sets the value of the 'Design Attributes' containment reference.

Parameters:
value - the new value of the 'Design Attributes' containment reference.
See Also:
getDesignAttributes()

isEditable

boolean isEditable()
A convenience method to indicate whether this property value is editable or read-only in a host designer. Applicable only if its container is visible, e.g. for public properties and input parameters.

Returns:
true if property is defined to be editable (default); false if the property value should be read only.
Since:
3.0.3
See Also:
getDesignAttributes()

isMaskedValue

boolean isMaskedValue()
A convenience method to indicate whether the property's input value should be masked or encrypted in persistent store and any UI display. Applies to default value as well.

Returns:
true if property value is defined to be masked; false otherwise. The default return value is false, if not explicitly defined.
Since:
3.0.3
See Also:
getDesignAttributes()


Copyright © 2006 -- 2008 Actuate, IBM Corporation, Sybase, Inc. and others. All rights reserved.