com.ibm.broker.config.appdev

Class FlowProperty

java.lang.Object

com.ibm.broker.config.appdev.FlowProperty

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PromotedProperty, UserDefinedProperty

public abstract class FlowProperty
extends java.lang.Object
implements java.io.Serializable

Each FlowProperty instance represents a User Defined Property or a Promoted Property. 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
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlowProperty.Type
static class	FlowProperty.Usage

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
FlowProperty()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBundleName()
java.lang.Object	getDefaultValue() Returns the default value of the User Defined Property
java.lang.String	getGroupName() Returns the group name of the User Defined Property
java.lang.String	getName() Returns the User Defined Property Name
java.lang.String	getPluginId()
FlowProperty.Type	getType() Gets the Type of this User Defined Property
FlowProperty.Usage	getUsage() Returns the usage of the User Defined Property either mandatory or optional
boolean	isConfigurable()
boolean	isUserDefined()
void	setBundleName(java.lang.String bundleName)
FlowProperty	setDefaultValue(java.lang.Object defaultValue) Sets the Default Value to the given Object
FlowProperty	setGroupName(java.lang.String groupName) Sets the group name of the User Defined Property
FlowProperty	setName(java.lang.String name) Sets the User Defined Property name
FlowProperty	setType(FlowProperty.Type type) Sets the type of this User Defined Property
FlowProperty	setUsage(FlowProperty.Usage usage) Sets the usage of this User Defined Property; mandatory or optional
java.lang.String	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

Constructor Detail

FlowProperty

public FlowProperty()

Method Detail

getName

public java.lang.String getName()

Returns the User Defined Property Name

Returns:

String; the Property Name

setName

public FlowProperty setName(java.lang.String name)

Sets the User Defined Property name

Parameters:

name - String; the User Defined Property name

getDefaultValue

public java.lang.Object getDefaultValue()

Returns the default value of the User Defined Property

Returns:

Object; the default Value of the User Defined Property

setDefaultValue

public FlowProperty setDefaultValue(java.lang.Object defaultValue)

Sets the Default Value to the given Object

Parameters:

defaultValue - Object; the given Object

setUsage

public FlowProperty setUsage(FlowProperty.Usage usage)

Sets the usage of this User Defined Property; mandatory or optional

Parameters:

usage - Usage;

getUsage

public FlowProperty.Usage getUsage()

Returns the usage of the User Defined Property either mandatory or optional

Returns:

Usage usage; the proprety usage

getGroupName

public java.lang.String getGroupName()

Returns the group name of the User Defined Property

Returns:

String groupName; the group name of the property

setGroupName

public FlowProperty setGroupName(java.lang.String groupName)

Sets the group name of the User Defined Property

Parameters:

groupName - String; the given group name

setType

public FlowProperty setType(FlowProperty.Type type)

Sets the type of this User Defined Property

Parameters:

type - Type; the type of this User Defined Property

getType

public FlowProperty.Type getType()

Gets the Type of this User Defined Property

Returns:

Type type;

getPluginId

public java.lang.String getPluginId()

Returns:

String pluginId;

isConfigurable

public boolean isConfigurable()

Returns:

boolean configurable; is this property configurable in the BAR Editor

isUserDefined

public boolean isUserDefined()

Returns:

boolean userDefined; is this a UDP

getBundleName

public java.lang.String getBundleName()

Returns:

String; bundle name

setBundleName

public void setBundleName(java.lang.String bundleName)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object