com.sap.caf.eu.gp.co.type.api

Interface IGPCallableObjectType

public interface IGPCallableObjectType

Field Summary

static String	PERMISSION_ADVANCED PERMISSION_ADVANCED – users assigned to either GP Expert User or GP Advanced User role will able to create CO of this type
static String	PERMISSION_BASIC PERMISSION_BASIC – users assigned to GP Expert User or GP Advanced User or GP Basic User will able to create CO of this type.
static String	PERMISSION_EXPERT PERMISSION_EXPERT – only users assigned to GP Expert User role will be able to create CO of this type
static String	PERMISSION_NOT_SELECTED defaultPermission – use PERMISSION_BASIC, PERMISSION_ADVANCED or PERMISSION_EXPERT to specify users from which design time roles will be able to create callable objects of this callable object type: PERMISSION_NOT_SELECTED - means that it is not shown in any Designtime, but it apairs in the Administration Tool and there the permission can be switch to BASIC, ADVANCED or EXPERT anytime by the administrator
static int	RUNTIME_CONTAINER_TYPE_J2EE_LIBRARY Implementation type: J2EE library The implementation of the run time container is deployed in a J2EE library (background callable objects only).
static int	RUNTIME_CONTAINER_TYPE_J2EE_SERVICE Implementation type: J2EE service The implementation of the run time container is deployed in a J2EE service (background callable objects only).
static int	RUNTIME_CONTAINER_TYPE_SESSION_BEAN Implementation type: Session Bean The implementation of the run time container is deployed as a stateless session bean (background callable objets only).
static int	RUNTIME_CONTAINER_TYPE_WD Implementation type: Web dynpro component The implementation of the run time container is deployed as a web dynpro component (visual callable objects only).

Method Summary

String	getConfigWdComponentName() Provides the name of the web dynpro component that provides the configuration dialog for callable objects of this type.
String	getConfigWdDevelopmentComponentName() Returns the name of the web dynpro application that provides the configuration dialog for callable objects of this type.
String	getContainerComponentName() Returns the name of the component within the development component.
String	getContainerDevComponentName() Returns the name of the run-time development component.
String	getContainerJNIName() Returns the JDNI name of the container session bean.
int	getContainerType() Returns the type of the run-time container implementation.
String	getDefaultPermission() Returns the default permission for this callable object type
String	getIconName() Resolves the name of the icon to be used when a callable object of this type is visualized.
String	getTypeName() Returns the unique identifier of the callable object type (must not exceed 32 characters).
boolean	isBackground() Returns whether or not callable objects of this type have to be executed in background.
boolean	isServicePattern() Returns whether or not this type of callable object can be used as a service-type pattern, e.g. for pre-filling something.
boolean	isVisible() Deprecated.
boolean	requiresConfigMaintenanceScreen() Returns whether or not a config maintenance screen is required.
boolean	requiresInputMaintenanceScreen() Returns whether or not an input maintenance screen is required.
boolean	requiresOutputMaintenanceScreen() Returns whether or not an output maintenance screen is required.
boolean	requiresServiceUserThreadIdentity() Specifies if the background container for the callable object must be run under the service user identity.
String	resolveDescriptionText(Locale locale) Resolves the description of the callable object type.
String	resolveTypeText(Locale locale) Resolves the text of the callable object type

Field Detail

RUNTIME_CONTAINER_TYPE_J2EE_LIBRARY

static final int RUNTIME_CONTAINER_TYPE_J2EE_LIBRARY

Implementation type: J2EE library

The implementation of the run time container is deployed in a J2EE library (background callable objects only).

See Also:

Constant Field Values

RUNTIME_CONTAINER_TYPE_J2EE_SERVICE

static final int RUNTIME_CONTAINER_TYPE_J2EE_SERVICE

Implementation type: J2EE service

The implementation of the run time container is deployed in a J2EE service (background callable objects only).

See Also:

Constant Field Values

RUNTIME_CONTAINER_TYPE_SESSION_BEAN

static final int RUNTIME_CONTAINER_TYPE_SESSION_BEAN

Implementation type: Session Bean

The implementation of the run time container is deployed as a stateless session bean (background callable objets only).

See Also:

Constant Field Values

RUNTIME_CONTAINER_TYPE_WD

static final int RUNTIME_CONTAINER_TYPE_WD

Implementation type: Web dynpro component

The implementation of the run time container is deployed as a web dynpro component (visual callable objects only).

See Also:

Constant Field Values

PERMISSION_NOT_SELECTED

static final String PERMISSION_NOT_SELECTED

defaultPermission – use PERMISSION_BASIC, PERMISSION_ADVANCED or PERMISSION_EXPERT to specify users from which design time roles will be able to create callable objects of this callable object type: PERMISSION_NOT_SELECTED - means that it is not shown in any Designtime, but it apairs in the Administration Tool and there the permission can be switch to BASIC, ADVANCED or EXPERT anytime by the administrator

See Also:

Constant Field Values

PERMISSION_BASIC

static final String PERMISSION_BASIC

PERMISSION_BASIC – users assigned to GP Expert User or GP Advanced User or GP Basic User will able to create CO of this type. Keep in mind that CO types with basic permission will be visible to the end users assigned to GP User role in Personal Templates design time where the end users can create their own simple process templates.

See Also:

Constant Field Values

PERMISSION_ADVANCED

static final String PERMISSION_ADVANCED

PERMISSION_ADVANCED – users assigned to either GP Expert User or GP Advanced User role will able to create CO of this type

See Also:

Constant Field Values

PERMISSION_EXPERT

static final String PERMISSION_EXPERT

PERMISSION_EXPERT – only users assigned to GP Expert User role will be able to create CO of this type

See Also:

Constant Field Values

Method Detail

getTypeName

String getTypeName()

Returns the unique identifier of the callable object type (must not exceed 32 characters).

Returns:

the unique name of the callable object type.

resolveTypeText

String resolveTypeText(Locale locale)

Resolves the text of the callable object type

Parameters:

locale -

Returns:

resolveDescriptionText

String resolveDescriptionText(Locale locale)

Resolves the description of the callable object type.

Parameters:

locale -

Returns:

getIconName

String getIconName()

Resolves the name of the icon to be used when a callable object of this type is visualized.

Returns:

isBackground

boolean isBackground()

Returns whether or not callable objects of this type have to be executed in background.

Returns:

getConfigWdDevelopmentComponentName

String getConfigWdDevelopmentComponentName()

Returns the name of the web dynpro application that provides the configuration dialog for callable objects of this type.

Returns:

getConfigWdComponentName

String getConfigWdComponentName()

Provides the name of the web dynpro component that provides the configuration dialog for callable objects of this type.

Returns:

getContainerType

int getContainerType()

Returns the type of the run-time container implementation.

Valid values are:

• RUNTIME_CONTAINER_TYPE_J2EE_LIBRARY
• RUNTIME_CONTAINER_TYPE_J2EE_SERVICE
• RUNTIME_CONTAINER_TYPE_SESSION_BEAN
• RUNTIME_CONTAINER_TYPE_WD

.

Returns:

the type of the run-time container implementation.

getContainerDevComponentName

String getContainerDevComponentName()

Returns the name of the run-time development component.

This value gives the name of the component. Applies to the following container types:

• RUNTIME_CONTAINER_TYPE_J2EE_LIBRARY: the name of the j2ee library.
• RUNTIME_CONTAINER_TYPE_J2EE_SERVICE: the name of the j2ee service.
• RUNTIME_CONTAINER_TYPE_WD: the name of the web dynpro development component.

Returns:

the name of the run-time component.

getContainerComponentName

String getContainerComponentName()

Returns the name of the component within the development component.

This value gives the name of the component. Applies to the following container types:

• RUNTIME_CONTAINER_TYPE_J2EE_LIBRARY: the name of the implementation class.
• RUNTIME_CONTAINER_TYPE_J2EE_SERVICE: the name of the implementation class.
• RUNTIME_CONTAINER_TYPE_WD: the name of the web dynpro component.

Returns:

getContainerJNIName

String getContainerJNIName()

Returns the JDNI name of the container session bean.

This name must be formed in the following way:

<vendor name>/<jndi-name of bean from ejb-j2ee-engine.xml>.

Only applies to the container type RUNTIME_CONTAINER_TYPE_SESSION_BEAN.

Returns:

the JNDI name of the container session bean.

requiresInputMaintenanceScreen

boolean requiresInputMaintenanceScreen()

Returns whether or not an input maintenance screen is required.

Returns:

whether or not an input maintenance screen is required.

requiresOutputMaintenanceScreen

boolean requiresOutputMaintenanceScreen()

Returns whether or not an output maintenance screen is required.

Returns:

whether or not an output maintenance screen is required.

requiresConfigMaintenanceScreen

boolean requiresConfigMaintenanceScreen()

Returns whether or not a config maintenance screen is required.

Returns:

whether or not a config maintenance screen is required.

isServicePattern

boolean isServicePattern()

Returns whether or not this type of callable object can be used as a service-type pattern, e.g. for pre-filling something.

isVisible

boolean isVisible()

Deprecated.

Returns whether or not this callable object is visible in gallery

getDefaultPermission

String getDefaultPermission()

Returns the default permission for this callable object type

Returns:

defaultPermission

requiresServiceUserThreadIdentity

boolean requiresServiceUserThreadIdentity()

Specifies if the background container for the callable object must be run under the service user identity. This method is applicable only for callable object types that are background. It is ignored if the callable object type is not background.

Returns:

the flag that specifies if the service user to be used. The default value is false.