com.ibm.broker.config.appdev

Class PromotedProperty

java.lang.Object

com.ibm.broker.config.appdev.FlowProperty

com.ibm.broker.config.appdev.PromotedProperty

All Implemented Interfaces:

java.io.Serializable

public class PromotedProperty
extends FlowProperty

Each PromotedProperty instance represents a Node Property which has been promoted to the Message Flow Each Message Flow contains a vector of FlowProperty which contains PromotedProperty (Node Promoted Properties) and UserDefinedProperty (User Defined Properties).

 Change Activity:
 -------- ----------- -------------   ------------------------------------
 Reason:  Date:       Originator:     Comments:
 -------- ----------- -------------   ------------------------------------
 xxxxx.x  2010-08-10  dstorey         v7.0.0.2 Release
 xxxxx.x  2011-07-06  dstorey         v8.0.0.0 Release
 xxxxx.x  2013-06-12  dstorey         v9.0.0.0 Release
 

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.broker.config.appdev.FlowProperty

FlowProperty.Type, FlowProperty.Usage

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	copyright
java.lang.String	href

Constructor Summary

Constructors

Constructor and Description
PromotedProperty(java.lang.String groupName, java.lang.String name, FlowProperty.Usage usage, FlowProperty.Type type, java.lang.Object defaultValue, Node[] overriddenNodes) Creates a new Flow Promoted Property which can be added to the Message Flows FlowProperties.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCompiler() The compiler used by this node property, if any.
boolean	getHidden() Returns the boolean hidden state of this promoted property
java.lang.String	getInternalName() The internal name of the property e.g.
Node[]	getOverriddenNodes() The nodes on which this flow property resides
java.lang.String	getPropertyEditor() The property editor which is used on this property, if any.
boolean	getReadOnly() Returns the boolean read only state of this promoted property
PromotedProperty	setCompiler(java.lang.String compiler) The compiler to be used by this flow property
void	setHidden(boolean value) Sets this promoted property to a hidden promoted property
PromotedProperty	setOverriddenNode(Node[] overriddenNodes) The node from which the property has been promoted
PromotedProperty	setPropertyEditor(java.lang.String propertyEditor) The property editor to apply to this property
void	setReadOnly(boolean value) Sets this promoted property to a read only promoted property

Methods inherited from class com.ibm.broker.config.appdev.FlowProperty

getBundleName, getDefaultValue, getGroupName, getName, getPluginId, getType, getUsage, isConfigurable, isUserDefined, setBundleName, setDefaultValue, setGroupName, setName, setType, setUsage, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

copyright

public static final java.lang.String copyright

See Also:

Constant Field Values

href

public java.lang.String href

Constructor Detail

PromotedProperty

public PromotedProperty(java.lang.String groupName,
                java.lang.String name,
                FlowProperty.Usage usage,
                FlowProperty.Type type,
                java.lang.Object defaultValue,
                Node[] overriddenNodes)

Creates a new Flow Promoted Property which can be added to the Message Flows FlowProperties. You may additionally need to associate a compiler and a property editor

Parameters:

groupName - String ; The name of the group which this Flow Promoted Property resides in

name - String ; The unique name of this Flow Promoted Property

usage - Usage ; The FlowProperty.Usage of this property; Mandatory or Optional

type - Type ; The Type of this Flow Promoted Property

defaultValue - Object ; The default value of this Flow Promoted Property

overriddenNodes - Node[] ; The nodes on which this Flow Promoted Property resides

Method Detail

setPropertyEditor

public PromotedProperty setPropertyEditor(java.lang.String propertyEditor)

The property editor to apply to this property

Parameters:

propertyEditor - String ;

getPropertyEditor

public java.lang.String getPropertyEditor()

The property editor which is used on this property, if any.

Returns:

propertyEditor String ;

setOverriddenNode

public PromotedProperty setOverriddenNode(Node[] overriddenNodes)

The node from which the property has been promoted

Parameters:

overriddenNodes - Node[] ; the nodes on which the promoted property resides

getOverriddenNodes

public Node[] getOverriddenNodes()

The nodes on which this flow property resides

Returns:

Node[];

getCompiler

public java.lang.String getCompiler()

The compiler used by this node property, if any.

Returns:

String ;

getInternalName

public java.lang.String getInternalName()

The internal name of the property e.g. queueName

Returns:

String ;

setCompiler

public PromotedProperty setCompiler(java.lang.String compiler)

The compiler to be used by this flow property

Parameters:

compiler -

setReadOnly

public void setReadOnly(boolean value)

Sets this promoted property to a read only promoted property

Parameters:

value -

getReadOnly

public boolean getReadOnly()

Returns the boolean read only state of this promoted property

Returns:

setHidden

public void setHidden(boolean value)

Sets this promoted property to a hidden promoted property

Parameters:

value -

getHidden

public boolean getHidden()

Returns the boolean hidden state of this promoted property

Returns: