Package de.hybris.platform.integrationservices.service

Interface IntegrationObjectService

All Known Implementing Classes:

DefaultIntegrationObjectService

public interface IntegrationObjectService

Provides methods to interact with Integration Object models.

Method Summary

Modifier and Type	Method	Description
java.util.Set<IntegrationObjectItemModel>	findAllDependencyTypes(java.lang.String integrationObjectItemCode, java.lang.String integrationObjectCode)	Find all the dependency types, which include dependencies of dependencies, for the given integration object item code.
java.util.Set<IntegrationObjectItemModel>	findAllIntegrationObjectItems(java.lang.String integrationObjectCode)	Find all integration object item models
java.util.Set<IntegrationObjectModel>	findAllIntegrationObjects(java.lang.String itemTypeCode)	Find all IntegrationObjectModel associated with IntegrationObjectItemModel, which associates with the given itemTypeCode.
AttributeDescriptorModel	findAttributeDescriptor(java.lang.String integrationObjectCode, java.lang.String integrationObjectItemCode, java.lang.String integrationObjectItemAttributeName)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811.0 - use findItemAttributeName(String, String, String) to get attribute name.
IntegrationObjectModel	findIntegrationObject(java.lang.String integrationObjectCode)	Find an integration object with the given code.
java.util.Optional<IntegrationObjectItemModel>	findIntegrationObjectItem(java.lang.String integrationObjectCode, java.lang.String integrationObjectItemCode)	Searches the integration object definitions for an item with the matching characteristics.
IntegrationObjectItemModel	findIntegrationObjectItemByParentTypeCode(java.lang.String integrationObjectCode, java.lang.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.
IntegrationObjectItemModel	findIntegrationObjectItemByTypeCode(java.lang.String integrationObjectCode, java.lang.String typeCode)	Find the integration object item's code referenced by the given integrationObjectCode and item type code.
java.lang.String	findItemAttributeName(java.lang.String integrationObjectCode, java.lang.String integrationObjectItemCode, java.lang.String integrationObjectItemAttributeName)	Find the attribute name if it exists for the given integrationObjectCode, integrationObjectItemCode, and integrationObjectItemAttributeName
java.lang.String	findItemTypeCode(java.lang.String integrationObjectCode, java.lang.String integrationObjectItemCode)	Find the type system type code referenced by the given integrationObjectCode and integrationObjectItemCode.

Method Detail

findIntegrationObject

IntegrationObjectModel findIntegrationObject(java.lang.String integrationObjectCode)

Find an integration object with the given code.

Parameters:

integrationObjectCode - Integration object's code

Returns:

integration object with the given code

findAllIntegrationObjectItems

java.util.Set<IntegrationObjectItemModel> findAllIntegrationObjectItems(java.lang.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

java.util.Set<IntegrationObjectItemModel> findAllDependencyTypes(java.lang.String integrationObjectItemCode,
                                                                 java.lang.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

java.util.Set<IntegrationObjectModel> findAllIntegrationObjects(java.lang.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

findAttributeDescriptor

@Deprecated(since="1811.0",
            forRemoval=true)
AttributeDescriptorModel findAttributeDescriptor(java.lang.String integrationObjectCode,
                                                 java.lang.String integrationObjectItemCode,
                                                 java.lang.String integrationObjectItemAttributeName)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811.0 - use findItemAttributeName(String, String, String) to get attribute name. Then call TypeService.getAttributeDescriptor(String, String) or TypeService.getAttributeDescriptor(ComposedTypeModel, String) with the ItemType and attribute name to get attribute descriptor.

Find an AttributeDescriptor if it exists for the given integrationObjectItemCode and integrationObjectItemAttributeName

Parameters:

integrationObjectCode - Integration object's code

integrationObjectItemCode - Integration object item's code

integrationObjectItemAttributeName - Integration object item attribute Name

Returns:

the AttributeDescriptorModel for the attribute.

Throws:

AttributeDescriptorNotFoundException - if attribute cannot be found.

findItemAttributeName

java.lang.String findItemAttributeName(java.lang.String integrationObjectCode,
                                       java.lang.String integrationObjectItemCode,
                                       java.lang.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

java.lang.String findItemTypeCode(java.lang.String integrationObjectCode,
                                  java.lang.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(java.lang.String integrationObjectCode,
                                                               java.lang.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(java.lang.String integrationObjectCode,
                                                                     java.lang.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

java.util.Optional<IntegrationObjectItemModel> findIntegrationObjectItem(java.lang.String integrationObjectCode,
                                                                         java.lang.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.