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

      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

      Optional<TypeDescriptor> getRootItemType()
      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.