fuego.papi
Interface AttachmentInterface

All Known Subinterfaces:

Attachment

public interface AttachmentInterface

Represents an Attachment associated with an instance.
This class is for internal use only.

Method Summary

long	getContentSize() Gets the content size in bytes.
String	getContentType() Gets the file content type.
Time	getCreationTime() Gets the attachment creation time.
String	getCreatorName() Gets the uid of the participant who created this attachment.
String	getDescription() Gets the attachment description.
Time	getEditionTime() Gets the edition time, which is the version creation time.
String	getId() Gets the attachment Id.
String	getLockerName() Gets the uid of the participant who has locked this attachment, or the empty string is this attachment is not locked.
String	getName() Gets the name of this attachment.
String	getRemarks() Gets the remarks for this version of the attachment.
int	getVersion() Gets the Version number of this attachment.

Method Detail

getContentSize

public long getContentSize()

Gets the content size in bytes.

Returns:

the content size in bytes.

getContentType

public String getContentType()

Gets the file content type. For example, "text/plain" or "application/ms-word".

Returns:

Content Type

getCreationTime

public Time getCreationTime()

Gets the attachment creation time.

Returns:

attachment creation time.

getCreatorName

public String getCreatorName()

Gets the uid of the participant who created this attachment.

Returns:

uid of the participant who created this attachment

getDescription

public String getDescription()

Gets the attachment description.

The description is only set when the attachment is created; remarks are set for each version.

Returns:

Attachment description.

getEditionTime

public Time getEditionTime()

Gets the edition time, which is the version creation time. If there is only one version, this will be the same as getCreationTime.

Returns:

Attachment edition time.

getId

public String getId()

Gets the attachment Id.

The format of the attachment id is "InstanceId/AttachmentIn/Version"

Returns:

Attachment Id.

getLockerName

public String getLockerName()

Gets the uid of the participant who has locked this attachment, or the empty string is this attachment is not locked.

Returns:

Uid of the participant who has locked this attachment, or the empty string is this attachment is not locked.

getName

public String getName()

Gets the name of this attachment.

While this is usually the filename, it can be set programmatically using ProcessServiceSession.instanceAttach(InstanceInfo, String, String, String, java.io.File), so there is no guarantee that it is the filename.

Returns:

Attachment name.

getRemarks

public String getRemarks()

Gets the remarks for this version of the attachment.

Returns:

remarks for this version of the attachment.

getVersion

public int getVersion()

Gets the Version number of this attachment.

Returns:

Version number of this attachment.