pro.taskana

Interface Attachment

All Known Implementing Classes:

AttachmentImpl

public interface Attachment

Attachment-Interface to specify Attachment Attributes.

Method Summary

Modifier and Type	Method and Description
AttachmentSummary	asSummary() Return a summary of the current Attachment.
String	getChannel() Returns the Channel on which the attachment was received.
ClassificationSummary	getClassificationSummary() Returns the classification summary of the attachment.
Instant	getCreated() Returns the time when the attachment was created.
Map<String,String>	getCustomAttributes() Returns the custom attributes of this attachment.
String	getId() Returns the current id of the attachment.
Instant	getModified() Returns the time when the attachment was last modified.
ObjectReference	getObjectReference() Returns the primaryObjectReference of the attachment.
Instant	getReceived() Returns the time when this attachment was received.
String	getTaskId() Returns the id of the associated task.
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.

Method Detail

getId

String getId()

Returns the current id of the attachment.

Returns:

ID of attachment

getTaskId

String getTaskId()

Returns the id of the associated task.

Returns:

taskId

getCreated

Instant getCreated()

Returns the time when the attachment was created.

Returns:

the created time as Instant

getModified

Instant getModified()

Returns the time when the attachment was last modified.

Returns:

modified Instant of the attachment

getClassificationSummary

ClassificationSummary getClassificationSummary()

Returns the classification summary of the attachment.

Returns:

the ClassificationSummary of this attachment

setClassificationSummary

void setClassificationSummary(ClassificationSummary classificationSummary)

Set the classification summary for this attachment.

Parameters:

classificationSummary - the ClassificationSummary for this attachment

getObjectReference

ObjectReference getObjectReference()

Returns the primaryObjectReference of the attachment.

Returns:

primaryObjectReference of the attachment

setObjectReference

void setObjectReference(ObjectReference objectReference)

Sets the primaryObjectReference of the attachment.

Parameters:

objectReference - the primaryObjectReference of the attachment

getChannel

String getChannel()

Returns the Channel on which the attachment was received.

Returns:

the Channel on which 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

getReceived

Instant getReceived()

Returns the time when this attachment was received.

Returns:

received time as exact Instant

setReceived

void setReceived(Instant received)

Sets the time when the attachment was received.

Parameters:

received - the time as Instant when 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