Package com.ptc.odata.core.entity.navigation

Class NavigationProcessorData

java.lang.Object

com.ptc.odata.core.entity.processor.EntityProcessorData

com.ptc.odata.core.entity.navigation.NavigationProcessorData

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

OperationProcessorData

public class NavigationProcessorData
extends EntityProcessorData

An EntityProcessor parameter object used for navigation entity associations.

Supported API: true

Extendable: false

See Also:

• EntityProcessorData
• EntityProviderProcessor

Method Summary

Modifier and Type	Method	Description
Collection<Object>	getAssociationObjects()	Returns the backing object(s) involved in a request which is modifying an entity association via references.
Map<URI,Object>	getAssociationParams()	Returns the map of entity association parameters to be used in a request modifying an entity association via references.
EntityConfig	getSourceEntityConfig()	Returns the source entity configuration which contains information such as name, description, collection name, attributes, operations ...etc about the entity.
Collection<Object>	getSourceObjects()	Returns the source objects for the navigation.
EntityConfig	getTargetEntityConfig()	Returns the target Entity Config to navigate to Supported API: true
String	getTargetSetName()	Returns the navigation name.
boolean	isTypeFilteredRelatedEntityCollection()	Indicates whether the related entity collection returned by the processor has been filtered according to the requested type cast. Note that this does not reflect any filter done by the $filter query option. Supported API: true
void	setSourceEntityConfig(EntityConfig sourceEntityConfig)	Sets the source entity configuration for the navigation.
void	setSourceObjects(Collection<Object> objects)	Sets the source objects for the navigation.

Methods inherited from class com.ptc.odata.core.entity.processor.EntityProcessorData

clone, findClosestAncestorEntitySetIncludedInServiceDocument, getAdditionalInfo, getAllAttributeProperties, getComplexType, getComplexTypePropertyDelegate, getComplexTypePropertyDelegates, getComplexTypeProvider, getCount, getCountOption, getDomainNameSpace, getEdmEntitySet, getEdmEntitySet, getEdmEntityType, getEdmProvider, getEntityConfig, getEntityProcessorData, getEntityPropertyByName, getEntityProvider, getEntitySetName, getEntityType, getEntityTypeForName, getEnumType, getEnumTypePropertyDelegate, getEnumTypePropertyDelegates, getEnumTypeProvider, getFilterOption, getHeaderProcessor, getHttpRequest, getJSFileForNavigation, getJSFilePaths, getLocale, getMultiOperation, getOdata, getOperation, getOrderByOption, getPagingParams, getPagingParamsProcessor, getProcessor, getProcessor, getProcessor, getProcessorByEntityFQNString, getProperty, getRequest, getRequestedEntityConfig, getRequestedEntityType, getResourcePathIdx, getSelectedURLContext, getSelectOption, getServiceMetadata, getUriInfo, getUriResource, hasFunctionResource, hasNavigationResource, hasNavigationResource, hasUriResourceEntitySet, hasUriResourceEntitySet, isContinueProcessing, isCountFetched, isFilterAppliedOnResults, isODataMetadataFull, isOrderByAppliedOnResults, isReferenceRequest, isUseSpecifiedEntityType, reCallGetEntityCollection, removeProperty, setAdditionalInfo, setComplexType, setComplexTypePropertyDelegates, setComplexTypeProvider, setContinueProcessing, setCount, setEdmEntitySet, setEdmEntityType, setEdmProvider, setEntityConfig, setEntityType, setEnumType, setEnumTypePropertyDelegates, setEnumTypeProvider, setFilterAppliedOnResults, setHeaderProcessor, setLocale, setMultiOperation, setOdata, setOperation, setOrderByAppliedOnResults, setPagingParams, setPagingParamsProcessor, setProperty, setReCallGetEntityCollection, setReferenceRequest, setRequest, setResourcePathIdx, setServiceMetadata, setUriInfo, setUriResource, setUseSpecifiedEntityType, updateDataToDerivedEntityType

Methods inherited from class java.lang.Object

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

Method Details

getTargetEntityConfig

public EntityConfig getTargetEntityConfig()

Returns the target Entity Config to navigate to

Supported API: true

Returns:

the navigation target entity config

getSourceEntityConfig

public EntityConfig getSourceEntityConfig()

Returns the source entity configuration which contains information such as name, description, collection name, attributes, operations ...etc about the entity.

Supported API: true

Returns:

the the source entity EntityConfig

setSourceEntityConfig

public void setSourceEntityConfig(EntityConfig sourceEntityConfig)

Sets the source entity configuration for the navigation.

Supported API: true

Parameters:

sourceEntityConfig - the source entity configuration for the navigation

setSourceObjects

public void setSourceObjects(Collection<Object> objects)

Sets the source objects for the navigation.

Supported API: true

Parameters:

objects - the source objects for the navigation

getSourceObjects

public Collection<Object> getSourceObjects()

Returns the source objects for the navigation.

Supported API: true

Returns:

Collection of source objects for the navigation

getTargetSetName

public String getTargetSetName()

Returns the navigation name.

Supported API: true

Returns:

navigation name

getAssociationParams

public Map<URI,Object> getAssociationParams()

Returns the map of entity association parameters to be used in a request modifying an entity association via references. The map is keyed by the URI specified in the request, and valued by the backing object.
NOTE: Some requests may implicitly define the entity being disassociated by specifying it via the URL path, rather than any explicit parameter via an $id query parameter or entity reference in the request body. The association parameters map will still contain the implicit entity reference URI as a key.

Supported API: true

Returns:

map of request URI to backing object

getAssociationObjects

public Collection<Object> getAssociationObjects()

Returns the backing object(s) involved in a request which is modifying an entity association via references. If you need to know the original URI associated to the backing object, use getAssociationParams() instead.

Supported API: true

Returns:

collection of backing objects loaded from the parameters for a request modifying an association via entity references

isTypeFilteredRelatedEntityCollection

public boolean isTypeFilteredRelatedEntityCollection()

Indicates whether the related entity collection returned by the processor has been filtered according to the requested type cast.
Note that this does not reflect any filter done by the $filter query option.

Supported API: true

Returns: