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

Interface IGPAttachmentSourceHandler

All Known Implementing Classes:

GPAbstractAttachmentSourceHandler

public interface IGPAttachmentSourceHandler

Each attachment carries the name of the handler as an attribute. The handler is responsible for:

• Providing a pointer to the web dynpro component that is responsible for creating the attachment. This web dynpro component must implement the web dynpro interface IAttachmentCreato defined in the development component caf/eu/gp/ui/wdapi.
• Providing an information data structure for an attachment that can be used by the run time and design time UIs to visualize the attachment in a list.

Note that the same instance is used for each handler throughout the server.

Version:

1.0

Method Summary

String	getCreationWdComponentName() Provides the name of the web dynpro component that provides the creation dialog for the attachment type.
String	getCreationWdDevelopmentComponentName() Returns the name of the web dynpro application that provides the creation dialog for the attachment type.
String	getName() Returns the name of the handler.
boolean	isAvailableAtDesignTime() Returns whether or not the handler is available at design time.
boolean	isAvailableAtRunTime() Returns whether or not the handler is available at run time.
boolean	isTransportable() Returns whether or not attachments of this type can be transported.
GPAttachmentInfo	resolveAttachmentInfo(IGPAttachment attachment, Locale locale) Resolves attachment information that can be used to display the attachment in a list in the design and run times.
String	resolveText(Locale locale) Resolves a human-readable display text for the attachment handler that can be presented to the end-user.

Method Detail

getName

String getName()

Returns the name of the handler. All handlers must be unique within a system.

Returns:

the name of the handler.

resolveText

String resolveText(Locale locale)

Resolves a human-readable display text for the attachment handler that can be presented to the end-user.

Parameters:

locale - the source handler's locale.

Returns:

a human-readable display text.

getCreationWdDevelopmentComponentName

String getCreationWdDevelopmentComponentName()

Returns the name of the web dynpro application that provides the creation dialog for the attachment type. of this type.

Returns:

getCreationWdComponentName

String getCreationWdComponentName()

Provides the name of the web dynpro component that provides the creation dialog for the attachment type. of this type.

Returns:

resolveAttachmentInfo

GPAttachmentInfo resolveAttachmentInfo(IGPAttachment attachment,
                                       Locale locale)
                                       throws GPEngineException

Resolves attachment information that can be used to display the attachment in a list in the design and run times.

Parameters:

locale - the locale to use for any language-dependent resolution that may occur.

Returns:

the attachment's information.

Throws:

EngineException - if an error occurs while resolving the attachment information.

GPEngineException

isAvailableAtDesignTime

boolean isAvailableAtDesignTime()

Returns whether or not the handler is available at design time.

Returns:

whether or not the handler is available at design time.

isAvailableAtRunTime

boolean isAvailableAtRunTime()

Returns whether or not the handler is available at run time.

Returns:

whether or not the handler is available at run time.

isTransportable

boolean isTransportable()

Returns whether or not attachments of this type can be transported.

Returns:

whether or not attachments of this type can be transported.