Class DefaultIntegrationItem
java.lang.Object
de.hybris.platform.integrationservices.item.DefaultIntegrationItem
- All Implemented Interfaces:
IntegrationItem
Default implementation of the
IntegrationItem interface-
Constructor Summary
ConstructorsConstructorDescriptionDefaultIntegrationItem(@NotNull TypeDescriptor type, String key) Instantiates this integration item.DefaultIntegrationItem(TypeDescriptor type, IntegrationItem containerItem) Instantiates this integration item. -
Method Summary
Modifier and TypeMethodDescriptionbooleanRetrieves value of an attribute.getAttribute(String name) Retrieves value of an attribute.Retrieves attributes present in this integration object.getContextItem(TypeDescriptor contextItemDescriptor) Retrieves a context item for the given TypeDescriptor if one exists.Retrieves integration key value for this item.Retrieves code of theIntegrationObjectModelthis item belongs to.Retrieves type of this integration item.getLocalizedAttribute(String attribute, String lang) Reads value of a localized attribute.getLocalizedAttribute(String attribute, Locale lang) Reads value of a localized attribute.getReferencedItem(TypeAttributeDescriptor attribute) Retrieves an integration item referenced by specified attribute.getReferencedItems(TypeAttributeDescriptor attribute) Retrieves multiple integration items referenced by specified attribute.inthashCode()booleansetAttribute(String attrName, Object value) Sets value of an attribute in this item.voidsetIntegrationKey(String key) Sets the integrationKey on this item.toString()
-
Constructor Details
-
DefaultIntegrationItem
Instantiates this integration item.- Parameters:
type- descriptor of the item type this new instance will havekey- integration key of this item. Integration key can benull
-
DefaultIntegrationItem
Instantiates this integration item.- Parameters:
type- descriptor of the item type this new instance will havecontainerItem- the integration item which containsthisitem
-
-
Method Details
-
getIntegrationObjectCode
Description copied from interface:IntegrationItemRetrieves code of theIntegrationObjectModelthis item belongs to.- Specified by:
getIntegrationObjectCodein interfaceIntegrationItem- Returns:
- value of the integration object code
-
getItemType
Description copied from interface:IntegrationItemRetrieves type of this integration item.- Specified by:
getItemTypein interfaceIntegrationItem- Returns:
- descriptor of how integration object item is defined for this item.
-
getIntegrationKey
Description copied from interface:IntegrationItemRetrieves integration key value for this item.- Specified by:
getIntegrationKeyin interfaceIntegrationItem- Returns:
- calculated integration key value for the item content.
-
getAttributes
Description copied from interface:IntegrationItemRetrieves attributes present in this integration object.- Specified by:
getAttributesin interfaceIntegrationItem- Returns:
- a subset of all possible item attributes defined in
IntegrationItem.getItemType()item type, which were set in this integration item. Even if an attribute was set tonull, e.g.setAttribute("myAttribute", null), a type attribute descriptor will be returned for"myAttribute", if it's an attribute defined for the item type.
-
setAttribute
Sets value of an attribute in this item.This method does enforce any invariants, e.g. attribute existence, match of the value type to the declared in the metadata, etc.
- Specified by:
setAttributein interfaceIntegrationItem- Parameters:
attrName- name of the attribute whose value needs to be set.value- a value for the attribute. In order to set a value for a localized attribute,LocalizedValueshould be passed as thevalue.- Returns:
true, if the value was successfully set, orfalse, if the specified attribute does not exist for this item.
-
getAttribute
Description copied from interface:IntegrationItemRetrieves value of an attribute.- Specified by:
getAttributein interfaceIntegrationItem- Parameters:
name- name of the attribute to read.- Returns:
- value for the specified attribute in this item or
null, if the attribute has not been set yet or does not exist. If attribute is localized, thenLocalizedValueis returned.
-
getAttribute
Description copied from interface:IntegrationItemRetrieves value of an attribute.- Specified by:
getAttributein interfaceIntegrationItem- Parameters:
attr-TypeAttributeDescriptorthat contains the information to get the value- Returns:
- value for the specified attribute in this item or
null, if the attribute has not been set yet or does not exist. If attribute is localized, thenLocalizedValueis returned.
-
getLocalizedAttribute
Reads value of a localized attribute.- Specified by:
getLocalizedAttributein interfaceIntegrationItem- Parameters:
attribute- name of the attribute to readlang- ISO code of the language, e.g. 'en' or 'es_CO', for which the attribute should be read. This is the value that can be read fromLocaleasLocale.toLanguageTag()- Returns:
- value of the specified attribute in the specified language or
null, if either the attribute or the language does not have a value set. - Throws:
IllegalArgumentException- when the attribute is not localized
-
getLocalizedAttribute
Reads value of a localized attribute. This method should ensure the specified attribute is indeed localized. Otherwise, the implementations should not return a value or indicate the problem by throwing an exception.- Specified by:
getLocalizedAttributein interfaceIntegrationItem- Parameters:
attribute- name of the attribute to readlang- language, for which the attribute should be read- Returns:
- value of the specified attribute in the specified language or
null, if either the attribute or the language does not have a value set. - Throws:
IllegalArgumentException- when the attribute is not localized
-
getReferencedItem
Description copied from interface:IntegrationItemRetrieves an integration item referenced by specified attribute. It does the same as callingIntegrationItem.getAttribute(String)but there is no need to cast result of that call toIntegrationItem.- Specified by:
getReferencedItemin interfaceIntegrationItem- Parameters:
attribute- attribute, whose value is a nestedIntegrationItem- Returns:
- the referenced item or
null, if this item does not contain the referenced item for the specified attribute name.
-
getReferencedItems
Description copied from interface:IntegrationItemRetrieves multiple integration items referenced by specified attribute. It does the same as callingIntegrationItem.getAttribute(String)but there is no need to cast result of that call toCollection<IntegrationItem>.- Specified by:
getReferencedItemsin interfaceIntegrationItem- Parameters:
attribute- attribute, whose value is a collection of nestedIntegrationItems- Returns:
- the referenced items. if this item does not contain referenced items for the specified attribute name, an empty
collection is returned. If the attribute references a single instance of an
IntegrationIteminstead of a collection, then a collection with that single item will be returned.
-
setIntegrationKey
Sets the integrationKey on this item.- Parameters:
key- integration key of this item. Integration key can benull
-
getContextItem
Description copied from interface:IntegrationItemRetrieves a context item for the given TypeDescriptor if one exists. This search is done recursively through the item's containers until a matching context item is found. If no context item exists,Optional.empty()is returned.- Specified by:
getContextItemin interfaceIntegrationItem- Parameters:
contextItemDescriptor- the type of the context item to find- Returns:
- the requested context item if one exists.
-
equals
-
hashCode
public int hashCode() -
toString
-