com.ibm.portal.propertybroker.property

Interface Property

All Superinterfaces:
java.io.Serializable
All known subinterfaces:
PropertyController

  1. public interface Property
  2. extends java.io.Serializable
Encapsulates property information. A property represents a data type which can be produced or consumed. The type information is used by the Property Broker to determine matches between properties produced by a source and properties consumed by a target. This interface does not have any dependencies on the specific runtime environment, as it is intended for reuse across different component runtime environments where brokered communication across components may be supported.

PropertyBrokerService may be used to create instances of Property. After instantiation, required fields must be set using setter methods on PropertyController.

Currently only Name is supported.

See Also:
PropertyBrokerService, PropertyController

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getClassname()
Returns class used to encapsulate the property value.
  1. java.lang.String
getName()
Returns the name of the property.
  1. java.lang.String
getNamespace()
Returns a string containing the type namespace.
  1. java.lang.Object
getOwningDefinitionId()
  1. java.lang.String
getType()
Returns a string containing the property type.

Method Detail

getName

  1. java.lang.String getName()
Returns the name of the property. Property names must be unique within the set associated with a component definition. The name is a required field (i.e. must not be null).
Returns:
a String containing the name of the property.

getType

  1. java.lang.String getType()
Returns a string containing the property type. The type is associated with the semantics of the property e.g. PhoneNo, orderID etc. This field is required.
Returns:
a String containing the property type.

getNamespace

  1. java.lang.String getNamespace()
Returns a string containing the type namespace. A namespace may be used to group related types in a domain of types, to prevent collisions with similarly named types created in a different domain. This is optional; if omitted, no namespace is used. No namespace is indicated by the empty string. If specified, it will be used in conjunction with type to restrict matches.
Returns:
a String containing the type namespace.
See Also:

getClassname

  1. java.lang.String getClassname()
Returns class used to encapsulate the property value. The default is String.
Returns:
a String containing the class name of the value of the property.

getOwningDefinitionId

  1. java.lang.Object getOwningDefinitionId( )