com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.ehsincidentcreate

Class Attachment

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>

com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<Attachment>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.ehsincidentcreate.Attachment

public class Attachment
extends VdmEntity<Attachment>

Attachment

Original entity name from the Odata EDM: Attachment

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attachment.AttachmentBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static AttachmentSelectable	ALL_FIELDS Selector for all available fields of Attachment.
static AttachmentField<UUID>	ATTACHMENT_DOCUMENT_UUID Use with available fluent helpers to apply the AttachmentDocumentUUID field to query operations.
static AttachmentField<String>	FILE_NAME Use with available fluent helpers to apply the FileName field to query operations.
static AttachmentField<String>	MIME_TYPE Use with available fluent helpers to apply the MimeType field to query operations.

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
Attachment()
Attachment(UUID attachmentDocumentUUID, String mimeType, String fileName)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static Attachment.AttachmentBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
InputStream	fetchAsStream() Get the binary data stream (file) from this entity.In the OData world this would be the /$value path.
static <T> AttachmentField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> AttachmentField<T>	field(String fieldName, TypeConverter<T,DomainT> typeConverter) Use with available fluent helpers to apply an extension field to query operations.
protected void	fromMap(Map<String,Object> inputValues)
UUID	getAttachmentDocumentUUID() (Key Field) Constraints: Not nullable
protected String	getDefaultServicePath() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
String	getFileName() Constraints: Not nullable, Maximum length: 255
protected Map<String,Object>	getKey()
String	getMimeType() Constraints: Not nullable, Maximum length: 128
Class<Attachment>	getType()
int	hashCode()
void	setAttachmentDocumentUUID(UUID attachmentDocumentUUID) (Key Field) Constraints: Not nullable
void	setFileName(String fileName) Constraints: Not nullable, Maximum length: 255
void	setMimeType(String mimeType) Constraints: Not nullable, Maximum length: 128
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
protected Map<String,Object>	toMapOfFields()
String	toString()

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields, toMapOfNavigationProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final AttachmentSelectable ALL_FIELDS

Selector for all available fields of Attachment.

ATTACHMENT_DOCUMENT_UUID

public static final AttachmentField<UUID> ATTACHMENT_DOCUMENT_UUID

Use with available fluent helpers to apply the AttachmentDocumentUUID field to query operations.

MIME_TYPE

public static final AttachmentField<String> MIME_TYPE

Use with available fluent helpers to apply the MimeType field to query operations.

FILE_NAME

public static final AttachmentField<String> FILE_NAME

Use with available fluent helpers to apply the FileName field to query operations.

Constructor Detail

Attachment

public Attachment()

Attachment

public Attachment(@Nullable
                  UUID attachmentDocumentUUID,
                  @Nullable
                  String mimeType,
                  @Nullable
                  String fileName)

Method Detail

getType

@Nonnull
public Class<Attachment> getType()

Specified by:

getType in class VdmObject<Attachment>

Returns:

The class of this object.

setAttachmentDocumentUUID

public void setAttachmentDocumentUUID(@Nullable
                                      UUID attachmentDocumentUUID)

(Key Field) Constraints: Not nullable

Original property name from the Odata EDM: AttachmentDocumentUUID

Parameters:

attachmentDocumentUUID - NodeID

setMimeType

public void setMimeType(@Nullable
                        String mimeType)

Constraints: Not nullable, Maximum length: 128

Original property name from the Odata EDM: MimeType

Parameters:

mimeType - HTML content type

setFileName

public void setFileName(@Nullable
                        String fileName)

Constraints: Not nullable, Maximum length: 255

Original property name from the Odata EDM: FileName

Parameters:

fileName - Relative storage location of physical document

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<Attachment>

Returns:

EDMX name of the entity collection identifier.

getKey

@Nonnull
protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<Attachment>

Returns:

The compound key of this object.

toMapOfFields

@Nonnull
protected Map<String,Object> toMapOfFields()

Overrides:

toMapOfFields in class VdmObject<Attachment>

fromMap

protected void fromMap(Map<String,Object> inputValues)

Overrides:

fromMap in class VdmObject<Attachment>

field

@Nonnull
public static <T> AttachmentField<T> field(@Nonnull
                                                    String fieldName,
                                                    @Nonnull
                                                    Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

Type Parameters:

T - The type of the extension field when performing value comparisons.

Parameters:

fieldName - The name of the extension field as returned by the OData service.

fieldType - The Java type to use for the extension field when performing value comparisons.

Returns:

A representation of an extension field from this entity.

field

@Nonnull
public static <T,DomainT> AttachmentField<T> field(@Nonnull
                                                            String fieldName,
                                                            @Nonnull
                                                            TypeConverter<T,DomainT> typeConverter)

Use with available fluent helpers to apply an extension field to query operations.

Type Parameters:

T - The type of the extension field when performing value comparisons.

DomainT - The type of the extension field as returned by the OData service.

Parameters:

typeConverter - A TypeConverter instance whose first generic type matches the Java type of the field

fieldName - The name of the extension field as returned by the OData service.

Returns:

A representation of an extension field from this entity, holding a reference to the given TypeConverter.

getDestinationForFetch

@Nullable
public HttpDestinationProperties getDestinationForFetch()

Description copied from class: VdmEntity

Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities). New destination to apply to this entity

Overrides:

getDestinationForFetch in class VdmEntity<Attachment>

Returns:

The stored destination for executing queries, or null if no such context has been set.

setServicePathForFetch

protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)

Description copied from class: VdmEntity

The service path only used for the fetch commands of this entity.

Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.

Overrides:

setServicePathForFetch in class VdmEntity<Attachment>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. Also applies to any associated entities (navigation properties) that were previously fetched.

Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.

Overrides:

attachToService in class VdmEntity<Attachment>

Parameters:

servicePath - Optional parameter. New service path to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the service path has never been set, then the service path will be set to the default defined in the corresponding service interface.

destination - New destination to apply to this entity and any associated entities that were previously fetched.

fetchAsStream

@Nonnull
public InputStream fetchAsStream()
                                   throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Get the binary data stream (file) from this entity.In the OData world this would be the /$value path.

Returns:

File content as an InputStream.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

getDefaultServicePath

protected String getDefaultServicePath()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<Attachment>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

builder

public static Attachment.AttachmentBuilder builder()

getAttachmentDocumentUUID

@Nullable
public UUID getAttachmentDocumentUUID()

(Key Field) Constraints: Not nullable

Original property name from the Odata EDM: AttachmentDocumentUUID

Returns:

NodeID

getMimeType

@Nullable
public String getMimeType()

Constraints: Not nullable, Maximum length: 128

Original property name from the Odata EDM: MimeType

Returns:

HTML content type

getFileName

@Nullable
public String getFileName()

Constraints: Not nullable, Maximum length: 255

Original property name from the Odata EDM: FileName

Returns:

Relative storage location of physical document

toString

public String toString()

Overrides:

toString in class VdmObject<Attachment>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<Attachment>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<Attachment>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<Attachment>