com.sap.caf.eu.gp.attachment.api

Interface IGPAttachment

public interface IGPAttachment

Attachment entity provides

• a unique ID (that may or may not be controlled by the attachment store)
• a display name
• an original file name
• a creator (for local templates only, during transport they are removed)
• a creation time stamp
• a mime type (a mapping can be done from the mime type to the attachment type)

Version:

1.0

Field Summary

static String	TYPE_FILE
static String	TYPE_URL
static String	TYPE_USER

Method Summary

byte[]	getContent() Get attachment raw-byte content.
Date	getCreated() Get creation date.
String	getCreator() Get creator of attachment.
String	getDisplayname() Get user-visible name of attachment.
String	getHandler() Returns the handler for an attachment.
String	getId() Get unique ID of attachment.
String	getOriginalFileName() Returns the original file name.
boolean	isRuntime() Check if this is a runtime attachment.

Field Detail

TYPE_FILE

static final String TYPE_FILE

See Also:

Constant Field Values

TYPE_URL

static final String TYPE_URL

See Also:

Constant Field Values

TYPE_USER

static final String TYPE_USER

See Also:

Constant Field Values

Method Detail

getId

String getId()

Get unique ID of attachment.

Returns:

unique ID

getDisplayname

String getDisplayname()

Get user-visible name of attachment.

Returns:

name of attachment

getOriginalFileName

String getOriginalFileName()

Returns the original file name.

Returns:

the original file name.

getHandler

String getHandler()

Returns the handler for an attachment.

Returns:

the attachment handler id.

getCreator

String getCreator()

Get creator of attachment.

Returns:

attachment creator

getCreated

Date getCreated()

Get creation date.

Returns:

creation date

getContent

byte[] getContent()
                  throws GPEngineException

Get attachment raw-byte content.

Returns:

attachment content

Throws:

EngineException - if the an error occurs while reading the actual attachment contents.

GPEngineException

isRuntime

boolean isRuntime()

Check if this is a runtime attachment.