com.sap.cloud.sdk.service.prov.api

Interface StructuredTypeMetadata

All Known Subinterfaces:

EntityMetadata

All Known Implementing Classes:

DefaultEntityMetadata

public interface StructuredTypeMetadata

This API is used to introspect the structure of a StructuredType like ComplexType property.

Method Summary

Modifier and Type	Method and Description
List<String>	getElementNames() Gets the names of the elements in the entity including those elements for which there is no data in the EntityData.
ElementType	getElementType(String elementName) Gets the type of the element
List<String>	getFlattenedElementNames() Gets the flattened names of the elements in the entity.
String	getName() Gets the name of the entity.
StructuredTypeMetadata	getStructuredTypeMetadata(String structuredTypeName) Gets the Metadata of a Structured Type

Method Detail

getName

String getName()

Gets the name of the entity.

Returns:

name of the Entity represented by this EntityMetadata.

getElementNames

List<String> getElementNames()

Gets the names of the elements in the entity including those elements for which there is no data in the EntityData.

Returns:

List of element of the entity.

getFlattenedElementNames

List<String> getFlattenedElementNames()

Gets the flattened names of the elements in the entity. Here flattened means that individual elements of a structured type will come as separate elements with name being the dot separated path starting from the structured type name till the element name. For simple elements coming directly under the entity, the name will simply be the element name. For example:- If an entity Customer has elements CustomerID, Name, Address, where Address is a structured type with sub elements City, Country, Then a call to getFlattenedElementNames will return the list {CustomerID, Name, Address.City, Address.Country}.

Returns:

List of element of the entity.

getElementType

ElementType getElementType(String elementName)

Gets the type of the element

Parameters:

elementName -

Returns:

ElementType

getStructuredTypeMetadata

StructuredTypeMetadata getStructuredTypeMetadata(String structuredTypeName)

Gets the Metadata of a Structured Type

Returns:

StructuredTypeMetadata representing Metadata of Structured Type.