de.hybris.platform.integrationbackoffice.services

Class ReadService

java.lang.Object

de.hybris.platform.integrationbackoffice.services.ReadService

public class ReadService
extends java.lang.Object

Handles the read requests from the extension's widgets

Constructor Summary

Constructors

Constructor and Description
ReadService()

Method Summary

Modifier and Type	Method and Description
java.util.Set<AttributeDescriptorModel>	getAttributesForType(ComposedTypeModel type) Get the set of AttributeDescriptionModel for a given ComposedTypeModel
java.util.List<ComposedTypeModel>	getAvailableTypes() Get ComposedTypedModels from type system
ComposedTypeModel	getComplexTypeForAttributeDescriptor(AttributeDescriptorModel attributeDescriptorModel) Gets a CollectionType's element's ComposedTypeModel (if it is a collection of complex types)
java.io.InputStream	getEDMX(IntegrationObjectModel integrationObject) Get an EDMX representation of a given integration object
java.util.List<IntegrationObjectModel>	getIntegrationObjectModels() Retrieves all IntegrationObjectModels
java.util.List<IntegrationType>	getIntegrationTypes() Retrieves all available IntegrationTypes
boolean	isAtomicType(java.lang.String attributeType) Checks whether a TypeModel's attribute type is an atomic type or a flexible atomic type
boolean	isCollectionType(java.lang.String attributeType) Checks whether a TypeModel's attribute type is a collection type or a flexible collection type
boolean	isComplexType(TypeModel typeModel) Checks whether a TypeModel is a ComposedType or an EnumerationMetaType
boolean	isComposedType(java.lang.String attributeType) Checks whether a TypeModel's attribute type is a composed type or a flexible composed type
boolean	isEnumerationMetaType(java.lang.String attributeType) Checks whether a TypeModel's attribute type is an enumeration meta type or a flexible enumeration meta type
boolean	isMapType(java.lang.String attributeType) Checks whether a TypeModel's attribute type is a map type or a flexible map type
void	setFlexibleSearchService(FlexibleSearchService flexibleSearchService)
void	setODataDefaultSchemaGenerator(SchemaGenerator oDataDefaultSchemaGenerator)
void	setTypeService(TypeService typeService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadService

public ReadService()

Method Detail

setODataDefaultSchemaGenerator

public void setODataDefaultSchemaGenerator(SchemaGenerator oDataDefaultSchemaGenerator)

setFlexibleSearchService

public void setFlexibleSearchService(FlexibleSearchService flexibleSearchService)

setTypeService

public void setTypeService(TypeService typeService)

isCollectionType

public boolean isCollectionType(java.lang.String attributeType)

Checks whether a TypeModel's attribute type is a collection type or a flexible collection type

Parameters:

attributeType - the attribute type to evaluate

Returns:

if the attribute type is of CollectionType

isComposedType

public boolean isComposedType(java.lang.String attributeType)

Checks whether a TypeModel's attribute type is a composed type or a flexible composed type

Parameters:

attributeType - the attribute type to evaluate

Returns:

if the attribute type is of ComposedType

isEnumerationMetaType

public boolean isEnumerationMetaType(java.lang.String attributeType)

Checks whether a TypeModel's attribute type is an enumeration meta type or a flexible enumeration meta type

Parameters:

attributeType - the attribute type to evaluate

Returns:

if the attribute type is of EnumerationMetaType

isAtomicType

public boolean isAtomicType(java.lang.String attributeType)

Checks whether a TypeModel's attribute type is an atomic type or a flexible atomic type

Parameters:

attributeType - the attribute type to evaluate

Returns:

if the attribute type is of AtomicType

isMapType

public boolean isMapType(java.lang.String attributeType)

Checks whether a TypeModel's attribute type is a map type or a flexible map type

Parameters:

attributeType - the attribute type to evaluate

Returns:

if the attribute type is of MapType

isComplexType

public boolean isComplexType(TypeModel typeModel)

Checks whether a TypeModel is a ComposedType or an EnumerationMetaType

Parameters:

typeModel - the type model to evaluate

Returns:

if the attribute is a complex type

getComplexTypeForAttributeDescriptor

public ComposedTypeModel getComplexTypeForAttributeDescriptor(AttributeDescriptorModel attributeDescriptorModel)

Gets a CollectionType's element's ComposedTypeModel (if it is a collection of complex types)

Parameters:

attributeDescriptorModel - the attribute descriptor of the collection

Returns:

the collection's element's ComposedTypeModel

getIntegrationObjectModels

public java.util.List<IntegrationObjectModel> getIntegrationObjectModels()

Retrieves all IntegrationObjectModels

Returns:

list of all IntegrationObjectModels

getIntegrationTypes

public java.util.List<IntegrationType> getIntegrationTypes()

Retrieves all available IntegrationTypes

Returns:

list of IntegrationTypes

getAvailableTypes

public java.util.List<ComposedTypeModel> getAvailableTypes()

Get ComposedTypedModels from type system

Returns:

list of ComposedTypeModels

getAttributesForType

public java.util.Set<AttributeDescriptorModel> getAttributesForType(ComposedTypeModel type)

Get the set of AttributeDescriptionModel for a given ComposedTypeModel

Parameters:

type - a ComposedTypeModel object

Returns:

the set of AttributeDescriptorModel of the ComposedTypeModel's attributes

getEDMX

public java.io.InputStream getEDMX(IntegrationObjectModel integrationObject)
                            throws InvalidODataSchemaException

Get an EDMX representation of a given integration object

Parameters:

integrationObject - an integration object to represent

Returns:

an input stream containing the EDMX representation of the integration object

Throws:

InvalidODataSchemaException - when schema generator fails