Interface IntegrationObjectService

All Known Implementing Classes:
DefaultIntegrationObjectService

public interface IntegrationObjectService
Provides methods to interact with Integration Object models.
  • Method Details

    • findIntegrationObject

      IntegrationObjectModel findIntegrationObject(String integrationObjectCode)
      Find an integration object with the given code.
      Parameters:
      integrationObjectCode - Integration object's code
      Returns:
      integration object with the given code
    • findAllIntegrationObjectItems

      Set<IntegrationObjectItemModel> findAllIntegrationObjectItems(String integrationObjectCode)
      Find all integration object item models
      Parameters:
      integrationObjectCode - Integration object's code
      Returns:
      Set of integration object items, or empty set if none is found
    • findAllDependencyTypes

      Set<IntegrationObjectItemModel> findAllDependencyTypes(String integrationObjectItemCode, String integrationObjectCode)
      Find all the dependency types, which include dependencies of dependencies, for the given integration object item code.
      Parameters:
      integrationObjectItemCode - Integration object item's code
      integrationObjectCode - Integration object's code
      Returns:
      Set of integration object items, or empty set if none is found
    • findAllIntegrationObjects

      Set<IntegrationObjectModel> findAllIntegrationObjects(String itemTypeCode)
      Find all IntegrationObjectModel associated with IntegrationObjectItemModel, which associates with the given itemTypeCode.
      Parameters:
      itemTypeCode - ComposedType associated with IntegrationObjectItemModel
      Returns:
      Set of integration objects, or empty set if none is found
    • findItemAttributeName

      String findItemAttributeName(String integrationObjectCode, String integrationObjectItemCode, String integrationObjectItemAttributeName)
      Find the attribute name if it exists for the given integrationObjectCode, integrationObjectItemCode, and integrationObjectItemAttributeName
      Parameters:
      integrationObjectCode - Integration object's code
      integrationObjectItemCode - Integration object item's code
      integrationObjectItemAttributeName - Integration object item attribute Name
      Returns:
      the name (qualifier) for the attribute as it is called in the Type System.
      Throws:
      AttributeDescriptorNotFoundException - if attribute cannot be found.
    • findItemTypeCode

      String findItemTypeCode(String integrationObjectCode, String integrationObjectItemCode)
      Find the type system type code referenced by the given integrationObjectCode and integrationObjectItemCode.
      Parameters:
      integrationObjectCode - Integration object's code
      integrationObjectItemCode - Integration object item's code
      Returns:
      typeCode of the integrationObjectItem or empty String if not found.
    • findIntegrationObjectItemByTypeCode

      IntegrationObjectItemModel findIntegrationObjectItemByTypeCode(String integrationObjectCode, String typeCode)
      Find the integration object item's code referenced by the given integrationObjectCode and item type code.
      Parameters:
      integrationObjectCode - Integration object's code
      typeCode - typeCode of the itemModel the IntegrationObjectItem refers to.
      Returns:
      the integrationObjectItem
    • findIntegrationObjectItemByParentTypeCode

      IntegrationObjectItemModel findIntegrationObjectItemByParentTypeCode(String integrationObjectCode, String typeCode)
      Find the integration object item's code referenced by the given integrationObjectCode and item type code also searching by the parent of the type code.
      Parameters:
      integrationObjectCode - Integration object's code
      typeCode - typeCode of the itemModel the IntegrationObjectItem refers to.
      Returns:
      the integrationObjectItem
    • findIntegrationObjectItem

      Optional<IntegrationObjectItemModel> findIntegrationObjectItem(String integrationObjectCode, String integrationObjectItemCode)
      Searches the integration object definitions for an item with the matching characteristics.
      Parameters:
      integrationObjectCode - code of the integration object that should contain the item.
      integrationObjectItemCode - code for an item withing the the specified integration object.
      Returns:
      an Optional containing the matching integration object item or an Optional.empty(), if the specified integration object does not exist or it exists but does not contain an item with the specified item code.