Package com.ptc.odata.core.entity.processor

Class EntityProcessorData

java.lang.Object
com.ptc.odata.core.entity.processor.EntityProcessorData
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
NavigationProcessorData
public class EntityProcessorData extends Object implements Cloneable
An EntityProcessor parameter object used for creating, reading, updating and deleting entities.

Supported API: true

Extendable: false
See Also:

  • Method Details

    • getLocale

      public Locale getLocale()
      The locale for request

      Supported API: true
      Returns:
      the Locale for the request

    • getEntityConfig

      public EntityConfig getEntityConfig()
      Returns the requested entity configuration

      Supported API: true
      Returns:
      the EntityConfig for the request

    • getEntitySetName

      public String getEntitySetName()
      Returns the requested entity set name

      Supported API: true
      Returns:
      the requested entity set name

    • getEntityType

      public EntityType getEntityType()
      Returns the requested entity type

      Supported API: true
      Returns:
      the request entity type

    • getSelectedURLContext

      public String getSelectedURLContext() throws PTCODataSerializerException
      Returns the requested select URL context for the requested entity type

      Supported API: true
      Returns:
      the context URL for the requested entity type
      Throws:
      org.apache.olingo.server.api.serializer.SerializerException
      PTCODataSerializerException

    • getOperation

      public EntityOperation getOperation()
      Returns EntityOperation of the request. Defaults to READ if not specified.

      Supported API: true
      Returns:
      the EntityOperation of the request

    • getProcessor

      @Deprecated public EntityObjectProcessor getProcessor(String entitySetName)
      Deprecated.
      Returns the EntityObjectProcessor for the given entity set name.

      Supported API: true
      Parameters:
      entitySetName - the entity set name for which to get the EntityObjectProcessor
      Returns:
      the EntityObjectProcessor for the given entity set name

    • getProcessorByEntityFQNString

      public EntityObjectProcessor getProcessorByEntityFQNString(String entityFQNString)
      Returns the EntityObjectProcessor for the given entity full qualified name.

      Supported API: true
      Parameters:
      entityFQNString - the entity full qualified name for which to get the EntityObjectProcessor
      Returns:
      the EntityObjectProcessor for the given entity set name

    • getProcessor

      public EntityObjectProcessor getProcessor()
      Returns the EntityObjectProcessor for the requested entity set name.

      Supported API: true
      Returns:
      the EntityObjectProcessor for the requested entity set name

    • setContinueProcessing

      public void setContinueProcessing(boolean continueProcessing)
      Sets whether or not EntityProcessors will continue with the default implementation processing at the completion of a javascript call.

      Supported API: true
      Parameters:
      continueProcessing - if true, continues with the default processing ; otherwise, continues with the javascript implementation.

    • getHttpRequest

      public jakarta.servlet.http.HttpServletRequest getHttpRequest()
      Returns the original HttpServletRequest

      Supported API: true
      Returns:
      the original HttpServletRequest

    • isFilterAppliedOnResults

      public boolean isFilterAppliedOnResults()
      Method to check if the filter is applied on the results
      .

      Supported API: true
      Returns:

    • setFilterAppliedOnResults

      public void setFilterAppliedOnResults(boolean filterAppliedOnResults)
      Indicates that the results have been filtered and no further filtering/sorting is required.

      Setting this flag tells the Framework and subsequent processing to stop filtering the entity collection from this point onwards. This effectively prevents any post filtering.

      Setting this flag can be desirable in several scenarios:
      - When implementing basic/custom entities where filtering is already done in readEntitySetData(EntityProcessorData)
      - When implementing navigations, where filtering is already done in getRelatedEntityCollection(NavigationProcessorData)
      - When implementing bound functions on an entity set, where the binding entity collection is already filtered.


      Supported API: true