com.ibm.portal.portletmodel
Interface CommunicationDatatype


public interface CommunicationDatatype

Interface that describes the semantics of data transferred by the property broker. Used to determine compatibility between communication sources and targets.

Since:
6.1.0.0

Method Summary
 IterableListModel<javax.xml.namespace.QName> getAliases()
          Returns a list of QNames that may be used in substitution to the semantic type of this communication datatype.
 java.lang.String getClassName()
          Returns the class used to encapsulate the transferred data.
 javax.xml.namespace.QName getQName()
          Returns a QName containing the semantic type of the transferred value, for example PhoneNo, OrderID and so forth.
 

Method Detail

getClassName

java.lang.String getClassName()
Returns the class used to encapsulate the transferred data.

Returns:
a String representing the class name.

getQName

javax.xml.namespace.QName getQName()
Returns a QName containing the semantic type of the transferred value, for example PhoneNo, OrderID and so forth. Two communication datatypes may use the same Java class (java.util.String for example), but carry different semantic meanings that are expressed by different semantic types

Returns:
a QName for the semantic type, never null.

getAliases

IterableListModel<javax.xml.namespace.QName> getAliases()
Returns a list of QNames that may be used in substitution to the semantic type of this communication datatype. The semantic type is contained in the list as well. Each alias defines an additional semantic meaning for the transferred value, e.g. PhoneNo, OrderID etc. Thus, a communication datatype may provide the same semantic meaning as a second one although the QName returned by getQName() may be different.

Returns:
a IterableListModel of QNames which serve as aliases for the initial semantic type, never null