class sap.ui.model.odata.type.Stream

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/model/odata/type/Stream
Application Component: CA-UI5-COR

This class represents the OData V4 primitive type Edm.Stream . The values for stream properties do not appear in the entity payload. Instead, the values are read or written through URLs.

This type only supports reading streams. For this purpose bind the stream property to a control property of type sap.ui.core.URI. {#formatValue} will then deliver the correct URL to read the stream.


Constructor

Constructor for an OData primitive type Edm.Stream.

new sap.ui.model.odata.type.Stream(oFormatOptions?, oConstraints?)
Param Type Default Value Description
oFormatOptions? object

Must be undefined

oConstraints? object

constraints; they are only stored for documentation purpose, since no validation can occur

nullable? boolean true

if true, the server accepts the value null


Methods Overview

Method Description
sap.ui.model.odata.type.Stream.extend

Creates a new subclass of class sap.ui.model.odata.type.Stream with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.model.odata.type.ODataType.extend.

formatValue

Returns the input value unchanged.

References:

  • sap.ui.model.SimpleType#formatValue

sap.ui.model.odata.type.Stream.getMetadata

Returns a metadata object for class sap.ui.model.odata.type.Stream.

getName

Returns the type's name.

References:

  • sap.ui.model.Type#getName

parseValue

Method not supported

References:

  • sap.ui.model.SimpleType#parseValue

validateValue

Method not supported

References:

  • sap.ui.model.SimpleType#validateValue

sap.ui.model.odata.type.Stream.extend

Creates a new subclass of class sap.ui.model.odata.type.Stream with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.model.odata.type.ODataType.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

formatValue

Returns the input value unchanged.

References:

Param Type DefaultValue Description
sValue string

the read URL

sTargetType string

The target type; must be "any" or "string"

sap.ui.model.odata.type.Stream.getMetadata

Returns a metadata object for class sap.ui.model.odata.type.Stream.

getName

Returns the type's name.

References:

parseValue

Method not supported

References:

validateValue

Method not supported

References: