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

Class GPAbstractAttachmentSourceHandler

java.lang.Object
  com.sap.caf.eu.gp.attachment.api.GPAbstractAttachmentSourceHandler

All Implemented Interfaces:

IGPAttachmentSourceHandler

public abstract class GPAbstractAttachmentSourceHandler
extends Object
implements IGPAttachmentSourceHandler

Attachment source handler base class.

Version:

1.0

Constructor Summary

GPAbstractAttachmentSourceHandler(String name, String wdComponentName, String dcName, boolean runtime, boolean designtime, boolean transport)

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.
abstract 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.
abstract String	resolveText(Locale locale) Resolves a human-readable display text for the attachment handler that can be presented to the end-user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GPAbstractAttachmentSourceHandler

public GPAbstractAttachmentSourceHandler(String name,
                                         String wdComponentName,
                                         String dcName,
                                         boolean runtime,
                                         boolean designtime,
                                         boolean transport)

Method Detail

getName

public String getName()

Description copied from interface: IGPAttachmentSourceHandler

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

Specified by:

getName in interface IGPAttachmentSourceHandler

Returns:

the name of the handler.

See Also:

IGPAttachmentSourceHandler.getName()

getCreationWdDevelopmentComponentName

public String getCreationWdDevelopmentComponentName()

Description copied from interface: IGPAttachmentSourceHandler

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

Specified by:

getCreationWdDevelopmentComponentName in interface IGPAttachmentSourceHandler

Returns:

See Also:

IGPAttachmentSourceHandler.getCreationWdDevelopmentComponentName()

getCreationWdComponentName

public String getCreationWdComponentName()

Description copied from interface: IGPAttachmentSourceHandler

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

Specified by:

getCreationWdComponentName in interface IGPAttachmentSourceHandler

Returns:

See Also:

IGPAttachmentSourceHandler.getCreationWdComponentName()

resolveText

public abstract String resolveText(Locale locale)

Description copied from interface: IGPAttachmentSourceHandler

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

Specified by:

resolveText in interface IGPAttachmentSourceHandler

Parameters:

locale - the source handler's locale.

Returns:

a human-readable display text.

See Also:

IGPAttachmentSourceHandler.resolveText(java.util.Locale)

resolveAttachmentInfo

public abstract GPAttachmentInfo resolveAttachmentInfo(IGPAttachment attachment,
                                                       Locale locale)
                                                throws GPEngineException

Description copied from interface: IGPAttachmentSourceHandler

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

Specified by:

resolveAttachmentInfo in interface IGPAttachmentSourceHandler

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

Returns:

the attachment's information.

Throws:

GPEngineException

See Also:

com.sap.caf.eu.gp.attachment.api.IGPAttachmentSourceHandler#resolveAttachmentInfo(null, java.util.Locale)

isAvailableAtDesignTime

public boolean isAvailableAtDesignTime()

Description copied from interface: IGPAttachmentSourceHandler

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

Specified by:

isAvailableAtDesignTime in interface IGPAttachmentSourceHandler

Returns:

whether or not the handler is available at design time.

See Also:

IGPAttachmentSourceHandler.isAvailableAtDesignTime()

isAvailableAtRunTime

public boolean isAvailableAtRunTime()

Description copied from interface: IGPAttachmentSourceHandler

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

Specified by:

isAvailableAtRunTime in interface IGPAttachmentSourceHandler

Returns:

whether or not the handler is available at run time.

See Also:

IGPAttachmentSourceHandler.isAvailableAtRunTime()

isTransportable

public boolean isTransportable()

Description copied from interface: IGPAttachmentSourceHandler

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

Specified by:

isTransportable in interface IGPAttachmentSourceHandler

Returns:

whether or not attachments of this type can be transported.

See Also:

IGPAttachmentSourceHandler.isTransportable()