Interface IntegrationObjectDescriptor
-
- All Known Implementing Classes:
DefaultIntegrationObjectDescriptor,NullIntegrationObjectDescriptor
public interface IntegrationObjectDescriptorDescribesIntegrationObject.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetCode()Reads integration object code.java.util.Optional<TypeDescriptor>getItemTypeDescriptor(ItemModel item)Retrieves item type defined in this integration object, corresponding to the specified data item.java.util.Set<TypeDescriptor>getItemTypeDescriptors()Retrieves descriptors for all integration object items defined in this integration object.java.util.Optional<TypeDescriptor>getRootItemType()Retrieves root item type in this integration object.
-
-
-
Method Detail
-
getCode
java.lang.String getCode()
Reads integration object code.- Returns:
- a code identifying the
IntegrationObject.
-
getItemTypeDescriptors
java.util.Set<TypeDescriptor> getItemTypeDescriptors()
Retrieves descriptors for all integration object items defined in this integration object.- Returns:
- a set of all non-primitive item type descriptors defined in this integration object or an empty set, if this integration object does not have a single integration object item defined yet.
-
getItemTypeDescriptor
java.util.Optional<TypeDescriptor> getItemTypeDescriptor(ItemModel item)
Retrieves item type defined in this integration object, corresponding to the specified data item.- Parameters:
item- an item to find a type descriptor for.- Returns:
- a descriptor for the item type corresponding to the specified item or an empty value, if the specified item is not related to this integration object.
-
getRootItemType
java.util.Optional<TypeDescriptor> getRootItemType()
Retrieves root item type in this integration object.- Returns:
- a descriptor for the root item type in this
IntegrationObjector an empty value, if root item type is not defined in this object.
-
-