Show TOC

Interface /IWBEP/IF_V4_ANNO_PROPERTYLocate this document in the navigation structure

This is the interface for annotations properties for OData version 4 (V4).

This interface includes interface /iwbep/if_v4_anno_item.

Methods
Method CREATE_ANNOTATION
This method creates an annotation.
Code Syntax
    importing
      IV_TERM_NAMESPACE type STRING
      IV_TERM_NAME type STRING
      IV_QUALIFIER type STRING optional
    returning
      value(RO_ANNOTATION) type ref to /IWBEP/IF_V4_ANNO_ANNOTATION
    raising
      /IWBEP/CX_V4_ANNOTATION .
Table 1:

Parameter

Description

iv_term_namespace

Term namespace.

iv_term_name

Term name.

iv_qualifier

Qualifier.

ro_annotation

Annotation.

Exceptions

The annotations exception is iwbep/cx_v4_annotation.

An exception is raised if the provided term name or term namespace is not valid according to the OData V4 specification. An exception is also raised if the provided term name or term namespace is initial. In addition, an exception is raised if an annotation with the same name and namespace has been already defined for the parent.

Method CREATE_CAST
This method creates a cast expression.
Code Syntax
    importing
      IV_TYPE_NAME type STRING
      IV_TYPE_NAMESPACE type STRING
    returning
      value(RO_CAST) type ref to /IWBEP/IF_V4_ANNO_CAST
    raising
      /IWBEP/CX_V4_ANNOTATION .
Table 2:

Parameter

Description

iv_type_name

Type name.

iv_type_namespace

Type namespace.

ro_cast

Cast expression.

Exceptions

The annotations exception is iwbep/cx_v4_annotation.

An exception is raised if the provided type name or type namespace is not valid according to the OData V4 specification.

Method CREATE_CON_EXP
This method creates a conditional expression. You can use constants from /iwbep/if_v4_anno_types=>gcs_con_expression_operator to provide values for parameter IV_CON_EXPR_OPERATOR.
Code Syntax
    importing
      IV_CON_EXPR_OPERATOR type /IWBEP/IF_V4_ANNO_TYPES=>TY_CON_EXPRESSION_OPERATOR
    returning
      value(RO_CON_EXP) type ref to /IWBEP/IF_V4_ANNO_COND_EXP
    raising
      /IWBEP/CX_V4_ANNOTATION .
Table 3:

Parameter

Description

iv_con_expr_operator

Conditional expression operator.

ro_con_exp

Annotations conditional expression.

Exceptions

The annotations exception is iwbep/cx_v4_annotation.

An exception is raised if the provided conditional expression is not supported.

Method CREATE_FUNCTION
This method creates a function.
Code Syntax
    importing
      IV_FUNCTION_NAMESPACE type STRING
      IV_FUNCTION_NAME type STRING
    returning
      value(RO_FUNCTION) type ref to /IWBEP/IF_V4_ANNO_FUNCTION
    raising
      /IWBEP/CX_V4_ANNOTATION .
Table 4:

Parameter

Description

iv_function_namespace

Annotation function namespace.

iv_function_name

Annotation function name.

ro_function

Annotation function.

Exceptions

The annotations exception is iwbep/cx_v4_annotation.

An exception is raised if the provided function name or namespace is not valid according to the OData V4 specification. An exception is also raised if the provided function name or namespace is initial.

Method CREATE_ISOF
This method creates an IsOf expression.
Code Syntax
    importing
      IV_TYPE_NAME type STRING
      IV_TYPE_NAMESPACE type STRING
    returning
      value(RO_ISOF) type ref to /IWBEP/IF_V4_ANNO_ISOF
    raising
      /IWBEP/CX_V4_ANNOTATION .
Table 5:

Parameter

Description

iv_type_name

Type name.

iv_type_namespace

Type namespace.

ro_isof

IsOf expression.

Exceptions

The annotations exception is iwbep/cx_v4_annotation.

An exception is raised if the provided type name or type namespace is not valid according to the OData V4 specification.

Method CREATE_COLLECTION
This method creates a collection.
Code Syntax
    returning
      value(RO_COLLECTION) type ref to /IWBEP/IF_V4_ANNO_COLLECTION
    raising
      /IWBEP/CX_V4_ANNOTATION .
Table 6:

Parameter

Description

ro_collection

Annotation collection.

Exceptions

The annotations exception is iwbep/cx_v4_annotation.

Method CREATE_NULL
This method creates a null expression.
Code Syntax
    returning
      value(RO_NULL) type ref to /IWBEP/IF_V4_ANNO_NULL
    raising
      /IWBEP/CX_V4_ANNOTATION .
Table 7:

Parameter

Description

ro_null

Annotations null expression.

Exceptions

The annotations exception is iwbep/cx_v4_annotation.

Method CREATE_RECORD
This method creates a record.
Code Syntax
    importing
      IV_RECORD_TYPE_NAMESPACE type STRING optional
      IV_RECORD_TYPE type STRING optional
    returning
      value(RO_RECORD) type ref to /IWBEP/IF_V4_ANNO_RECORD
    raising
      /IWBEP/CX_V4_ANNOTATION .
Table 8:

Parameter

Description

iv_record_type_namespace

Record type namespace.

iv_record_type

Record type.

ro_record

Annotations record type.

Exceptions

The annotations exception is iwbep/cx_v4_annotation.

An exception is raised if the provided record type name or record type namespace is not valid according to the OData V4 specification.

Method CREATE_SIMPLE_VALUE
This method creates a simple value. Once created, the simple value can be later defined as one of the following:
  • binary

  • boolean
  • date
  • decimal
  • duration
  • path
  • string
Code Syntax
    returning
      value(RO_SIMPLE_VALUE) type ref to /IWBEP/IF_V4_ANNO_SIMP_VAL
    raising
      /IWBEP/CX_V4_ANNOTATION .
Table 9:

Parameter

Description

ro_simple_value

Vocabulary annotations simple value.

Exceptions

The annotations exception is iwbep/cx_v4_annotation.

Method CREATE_URL
This method creates an URL.
Code Syntax
    returning
      value(RO_URL) type ref to /IWBEP/IF_V4_ANNO_URL
    raising
      /IWBEP/CX_V4_ANNOTATION .
Table 10:

Parameter

Description

ro_url

Annotation URL.

Exceptions

The annotations exception is iwbep/cx_v4_annotation.