pro.taskana.task.api.models

Interface Attachment

All Superinterfaces:

AttachmentSummary

All Known Implementing Classes:

AttachmentImpl

public interface Attachment
extends AttachmentSummary

Attachment-Interface to specify Attachment Attributes.

Method Summary

Modifier and Type	Method and Description
AttachmentSummary	asSummary() Return a summary of the current Attachment.
Map<String,String>	getCustomAttributes() Returns the custom attributes of this attachment.
void	setChannel(String channel) Sets the Channel on which the attachment was received.
void	setClassificationSummary(ClassificationSummary classificationSummary) Set the classification summary for this attachment.
void	setCustomAttributes(Map<String,String> customAttributes) Sets the custom attribute Map of the attachment.
void	setObjectReference(ObjectReference objectReference) Sets the primaryObjectReference of the attachment.
void	setReceived(Instant received) Sets the time when the attachment was received.

Methods inherited from interface pro.taskana.task.api.models.AttachmentSummary

getChannel, getClassificationSummary, getCreated, getId, getModified, getObjectReference, getReceived, getTaskId

Method Detail

setObjectReference

void setObjectReference(ObjectReference objectReference)

Sets the primaryObjectReference of the attachment.

Parameters:

objectReference - the primaryObjectReference of the attachment

setClassificationSummary

void setClassificationSummary(ClassificationSummary classificationSummary)

Set the classification summary for this attachment.

Parameters:

classificationSummary - the ClassificationSummary for this attachment

setReceived

void setReceived(Instant received)

Sets the time when the attachment was received.

Parameters:

received - the time as Instant when the attachment was received

setChannel

void setChannel(String channel)

Sets the Channel on which the attachment was received.

Parameters:

channel - the channel on which the attachment was received

getCustomAttributes

Map<String,String> getCustomAttributes()

Returns the custom attributes of this attachment.

Returns:

customAttributes as Map

setCustomAttributes

void setCustomAttributes(Map<String,String> customAttributes)

Sets the custom attribute Map of the attachment.

Parameters:

customAttributes - a Map that contains the custom attributes of the attachment as key, value pairs

asSummary

AttachmentSummary asSummary()

Return a summary of the current Attachment.

Returns:

the AttachmentSummary object for the current attachment