com.ibm.broker.config.appdev

Class UserDefinedProperty

  • All Implemented Interfaces:
    java.io.Serializable


    public class UserDefinedProperty
    extends FlowProperty

    Each UserDefinedProperty instance represents a User Defined Flow Property on a Message Flow within a WebSphere Message Broker 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-07-17  dstorey          v9.0.0.0 Release
     
    See Also:
    Serialized Form
    • Constructor Detail

      • UserDefinedProperty

        public UserDefinedProperty(java.lang.String groupName,
                                   java.lang.String name,
                                   FlowProperty.Usage usage,
                                   FlowProperty.Type type,
                                   java.lang.Object defaultValue)
        Creates a new User Defined Property which you can add to a message flow
           UserDefinedProperty flowUDP = new UserDefinedProperty("Group1HW", "Property1", UserDefinedProperty.Usage.MANDATORY,
                UserDefinedProperty.Type.STRING, "Hello World!");
           mf.addFlowProperty(flowUDP);
         
        Parameters:
        groupName - String ; The name of the group which this User Defined Property resides in
        name - String ; The unique name of this User Defined Property
        usage - Usage ; The FlowPropertyUserDefined.Usage of this property; Mandatory or Optional
        type - Type ; The Type of this User Defined Property
        defaultValue - Object ; The default value of this User Defined Property
    • Method Detail

      • setReadOnly

        public void setReadOnly(boolean value)
        Sets this property to a read only user defined property
        Parameters:
        value -
      • getReadOnly

        public boolean getReadOnly()
        Returns the boolean read only state of this user defined property
        Returns:
        boolean read only state
      • setHidden

        public void setHidden(boolean value)
        Sets this property to a hidden user defined property
        Parameters:
        value -
      • getHidden

        public boolean getHidden()
        Returns the boolean hidden state of this user defined property
        Returns:
        boolean hidden state