Interface IntegrationObjectDescriptor

All Known Implementing Classes:
DefaultIntegrationObjectDescriptor, NullIntegrationObjectDescriptor

public interface IntegrationObjectDescriptor
Describes IntegrationObject.
  • Method Details

    • getCode

      String getCode()
      Reads integration object code.
      Returns:
      a code identifying the IntegrationObject.
    • getItemTypeDescriptors

      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

      @Deprecated(since="2211.FP1", forRemoval=true) Optional<TypeDescriptor> getItemTypeDescriptor(ItemModel item)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.
    • getTypeDescriptor

      default Optional<TypeDescriptor> getTypeDescriptor(Object payloadObject)
      Retrieves the TypeDescriptor for the type defined in this integration object, corresponding to the specified data item.
      Parameters:
      payloadObject - an item or pojo to find a type descriptor for.
      Returns:
      a descriptor for the item type or POJO corresponding to the specified item or an empty value, if the specified item is not related to this integration object.
    • getRootItemType

      @Deprecated(since="2211.FP1", forRemoval=true) Optional<TypeDescriptor> getRootItemType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use getRootType() instead.
      Retrieves root item type in this integration object.
      Returns:
      a descriptor for the root item type in this IntegrationObject or an empty value, if root item type is not defined in this object.
    • getRootType

      default Optional<TypeDescriptor> getRootType()
      Retrieves root item type in this integration object.
      Returns:
      a descriptor for the root item type in this IntegrationObject or an empty value, if root item type is not defined in this object.
    • contains

      default boolean contains(TypeDescriptor descriptor)
      Checks whether the specified type descriptor is explicitly defined in the integration object
      Parameters:
      descriptor - a type descriptor to check
      Returns:
      true, if the type descriptor is explicitly defined in the integration object as an item or class; false otherwise