[OASIS Issue Tracker] (ODATA-816) Add Capability term for filter expression restrictions

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

     [ https://issues.oasis-open.org/browse/ODATA-816?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael Pizzo updated ODATA-816:
--------------------------------

    Proposal: 
Extend the term FilterRestriction with an additional property FilterExpressionRestrictions:

      <Term Name="FilterRestrictions" Type="Capabilities.FilterRestrictionsType" AppliesTo="EntitySet">
        <Annotation Term="Core.Description" String="Restrictions on $filter expressions" />
      </Term>
      <ComplexType Name="FilterRestrictionsType">
        ...
        <Property Name="FilterExpressionRestrictions" Type="Collection(Capabilities.FilterExpressionRestrictionType)">
          <Annotation Term="Core.Description" String="These properties only allow a subset of expressions" />
        </Property>
      </ComplexType>
      <ComplexType Name="FilterExpressionRestrictionType">
        <Property Name="Property" Type="Edm.PropertyPath" />
        <Property Name="AllowedExpressions" Type="Capabilities.FilterExpressionType" />
      </ComplexType>
      <EnumType Name="FilterExpressionType"> <!-- rewrite as allowable values for future extensibility-->
        <Member Name="SingleValue">
          <Annotation Term="Core.Description" String="Property can be used in a single eq clause" />
        </Member>
        <Member Name="MultiValue">
          <Annotation Term="Core.Description" String="Property can be used in a single in clause" />
        </Member>
        <Member Name="SingleRange">
          <Annotation Term="Core.Description"
            String="Property can be used in at most one ge and/or one le clause, separated by and" />
        </Member>
      </EnumType>

NOTE: the enum should be rewritten as allowable values for future extensibility.

  was:
Extend the term FilterRestriction with an additional property FilterExpressionRestrictions:

      <Term Name="FilterRestrictions" Type="Capabilities.FilterRestrictionsType" AppliesTo="EntitySet">
        <Annotation Term="Core.Description" String="Restrictions on $filter expressions" />
      </Term>
      <ComplexType Name="FilterRestrictionsType">
        ...
        <Property Name="FilterExpressionRestrictions" Type="Collection(Capabilities.FilterExpressionRestrictionType)">
          <Annotation Term="Core.Description" String="These properties only allow a subset of expressions" />
        </Property>
      </ComplexType>
      <ComplexType Name="FilterExpressionRestrictionType">
        <Property Name="Property" Type="Edm.PropertyPath" />
        <Property Name="AllowedExpressions" Type="Capabilities.FilterExpressionType" />
      </ComplexType>
      <EnumType Name="FilterExpressionType">
        <Member Name="SingleValue">
          <Annotation Term="Core.Description" String="a single eq clause" />
        </Member>
        <Member Name="MultiValue">
          <Annotation Term="Core.Description" String="several eq clauses, separated by or, are possible" />
        </Member>
        <Member Name="SingleInterval">
          <Annotation Term="Core.Description"
            String="at most one ge and one le clause, separated by and, alternatively a single eq clause" />
        </Member>
      </EnumType>


> Add Capability term for filter expression restrictions
> ------------------------------------------------------
>
>                 Key: ODATA-816
>                 URL: https://issues.oasis-open.org/browse/ODATA-816
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: Vocabularies
>    Affects Versions: V4.0_ERRATA02
>         Environment: Annotations
>            Reporter: Ralf Handl
>            Assignee: Ralf Handl
>              Labels: Extension, Usability
>             Fix For: V4.01_WD01
>
>
> We regularly encounter situations where filter expressions on certain properties are restricted to
> - single-value: only a single “eq”clause is possible
> - multi-value: several  “eq” clauses, separated by or, are possible
> - interval: at most one “ge” and one “le” clause, separated by “and”, alternatively a single “eq” clause



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)