Package com.ptc.odata.windchill.entity

Class WcEntityConfig

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

com.ptc.odata.windchill.entity.WcEntityConfig

All Implemented Interfaces:

Comparable

public class WcEntityConfig
extends EntityConfig

Windchill specific entity config. Provides additional configuration properties:

wcType

Supported API: true

Extendable: false

Field Summary

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

BASIC_TYPE, COLLECTION_NAME, EXTENDS, GENERATE_CANONICAL_LINKS, GENERATE_DOMAIN_SPECIFIC_LINKS, HAS_STREAM, ID, INCLUDE_IN_SCHEMA, INCLUDE_IN_SERVICE_DOCUMENT, MULTI_OPERATIONS, OPERATIONS, RB_INFO_FOR_DISPLAY_NAME, supportedMultiOperations

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
URI	getURI(String id)	Used for generating a specific entity encoded URI for the given identifier.
List<String>	getWcExcludedTypes()	The specific Windchill sub-types excluded for this entity.
String	getWcType()	The specific Windchill type for this entity Supported API: true
Class	getWcTypeClass()	The specific Windchill type base class for this entity Supported API: true
boolean	includeInServiceDocument()	The indicates if the entity collection is supported as a service.

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

addChildEntityConfig, addEntityOperationsAnnotation, addExtendsConfig, addPropertyKey, compareTo, equals, generateCanonicalLinks, getActions, getChildren, getCollectionName, getExtendedEntityConfigs, getExtends, getFunctions, getGenerateDomainSpecificLinks, getJSFileForNavigation, getJSFilePaths, getMultiOperation, getName, getNavigationProperties, getNavigationProperties, getNavigationPropertyBindings, getOperation, getParentConfigName, getParentEntityConfig, getRbInfoForDisplayName, getSupportedSince, getURI, getURIPath, getURIPath, hasCommonProperties, hashCode, hasParent, includeInSchema, isBasicType, isBoundOperation, isDomainEntityConfig, isExtended, isGeneratedEntityConfig, isMultiOperationSupported, isOperationSupported, isTypeAssignable, setConfigFilePath, setDomainEntityConfig, setGeneratedEntityConfig, setHasCommonProperties, setParentEntityConfig

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, hasPropertyKeyRef, isEnabled, isValidName, setConfig, setEnforceValidODataIdentifier

Methods inherited from class java.lang.Object

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

Method Details

getWcType

public String getWcType()

The specific Windchill type for this entity

Supported API: true

Returns:

The internal name of the type definition this entity is linked to.

getWcExcludedTypes

public List<String> getWcExcludedTypes()

The specific Windchill sub-types excluded for this entity.

All child types of the excluded sub-types will also be excluded.

Supported API: true

Returns:

List of internal names of the windchill sub-types that should be excluded for this entity. Will not return null.

getWcTypeClass

public Class getWcTypeClass()

The specific Windchill type base class for this entity

Supported API: true

Returns:

The class for the persistable business object that instances of the type related to this entity will be.

getURI

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

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

Supported API: true

Overrides:

getURI in class EntityConfig

Throws:

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

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

Overrides:

includeInServiceDocument in class EntityConfig

Throws:

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