Package com.ptc.odata.core.entity

Class EntityConfig

java.lang.Object

com.ptc.odata.core.AbstractConfig

com.ptc.odata.core.entity.operation.AbstractOperationContainerConfig

com.ptc.odata.core.entity.AbstractEntityConfig

com.ptc.odata.core.entity.EntityConfig

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

WcEntityConfig

public class EntityConfig
extends AbstractEntityConfig
implements Comparable

A configuration class used to read and hold configured domain entities JSON files in the either the /rest/ptc/domain/{domainId}/entity/ or /rest/custom/domain/{domainId}/entity/ paths.

Supported API: true

Extendable: false

Field Summary

Fields inherited from class com.ptc.odata.core.entity.AbstractEntityConfig

domainConfig, edmProvider, JS_EXT, JSON_EXT, jsonFilePath, OPEN_TYPE

Fields inherited from class com.ptc.odata.core.AbstractConfig

DESCRIPTION, ENABLED, NAME, PROPERTY_ENFORCE_VALID_IDENTIFIER, PROPERTY_PROPERTY_KEY_REF, PROPERTY_SUPPORTED_SINCE, PROPERTY_TYPE

Method Summary

Modifier and Type	Method	Description
String	getType()	A selector used to determine the appropriate EntityProviderDelegate to use.
URI	getURI(long id)	Used for generating a specific entity URI for the given identifier.
URI	getURI(String id)	Used for generating a specific entity URI for the given identifier.
boolean	includeInServiceDocument()	The indicates if the entity collection is supported as a service.
boolean	isBasicType()	Returns true if the type of the entity is basic Supported API: true
boolean	isOperationSupported(EntityOperation entityOperation)	Used to determine if the provided entity operation is a supported operations for the entity configuration.

Methods inherited from class com.ptc.odata.core.entity.AbstractEntityConfig

getDomainConfig, getEnforceValidODataIdentifier, getFullQualifiedName, getNameSpace, isOpenType, setDomainConfig, toString

Methods inherited from class com.ptc.odata.core.AbstractConfig

addDescriptionAnnotation, getAnnotationValue, getConfig, getConfigBoolean, getConfigInteger, getConfigString, getConfigStringArray, getDescription, hasPropertyKeyRef, isEnabled, isValidName, setConfig, setEnforceValidODataIdentifier

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

includeInServiceDocument

public boolean includeInServiceDocument()
                                 throws org.apache.olingo.commons.api.ex.ODataException

The indicates if the entity collection is supported as a service. Defaults to true when the entity has no base type set. If the entity has a base type set then defaults to false.

Supported API: true

Throws:

org.apache.olingo.commons.api.ex.ODataException

getType

public String getType()
               throws org.apache.olingo.commons.api.ex.ODataException

A selector used to determine the appropriate EntityProviderDelegate to use. Defaults to "basic" for the BasicEntityProviderDelegate.

Supported API: true

Overrides:

getType in class AbstractConfig

Throws:

org.apache.olingo.commons.api.ex.ODataException

See Also:

• EntityProviderDelegate
• BasicEntityProviderDelegate

getURI

public URI getURI(long id)
           throws org.apache.olingo.commons.api.ex.ODataException

Used for generating a specific entity URI for the given identifier.

Supported API: true

Throws:

org.apache.olingo.commons.api.ex.ODataException

getURI

public URI getURI(String id)
           throws org.apache.olingo.commons.api.ex.ODataException

Used for generating a specific entity URI for the given identifier.

Supported API: true

Throws:

org.apache.olingo.commons.api.ex.ODataException

isOperationSupported

public boolean isOperationSupported(EntityOperation entityOperation)

Used to determine if the provided entity operation is a supported operations for the entity configuration.

Supported API: true

isBasicType

public boolean isBasicType()

Returns true if the type of the entity is basic

Supported API: true

Returns: