com.sap.caf.eu.gp.base.api

Interface IGPDevelopmentObject

All Known Subinterfaces:

IGPAction, IGPActivity, IGPBlock, IGPBusinessObject, IGPCallableObject, IGPFormDevObject, IGPModifiableAction, IGPModifiableActivity, IGPModifiableBlock, IGPModifiableBusinessObject, IGPModifiableDevelopmentObject, IGPModifiableFormDevObject, IGPModifiableProcess, IGPProcess

public interface IGPDevelopmentObject

The basic interface for all Guided Procedure objects describing process definitions. The interface provides readonly access to the development object properties. All GP objects have id and version, as well as permissions. All version of a GP development object share the same UUID and differ in their version part.They are ssigned to category(s). Every GP object have input and output parameters. Title and description are edited in the original language, but can be transalted using SAP translation mechanism.

Version:

1.0

Method Summary

String[]	getCategories() Returns the ids of the categories to which this development object is attached to
String	getDescription() Returns the description in the original locale
String	getID() Returns the development object unique identifier as an UUID
IGPStructureInfo	getInputParameters() Returns the input parameters definition
IGPMetadata	getMetadata() Returns the development object metadata
Locale	getOriginalLocale() Returns the original locale for this development object
IGPStructureInfo	getOutputParameters() Returns the input parameters definition
Iterator	getPermissions() Returns all permissions that apply to the Development Object.
GPDevelopmentObjectStatus	getStatus() Returns the development object status
String	getTitle() Returns the title in the original locale
IGPDevelopmentObjectType	getType() Returns the development object type.
IGPVersionNumber	getVersionNumber() The version number of this development object
String	resolveDescription(Locale locale) Returns the description in the specified locoale or the description in the original locale if the object is not translated.
String	resolveTitle(Locale locale) The title text in the specified locale

Method Detail

getID

String getID()

Returns the development object unique identifier as an UUID

Returns:

the id of the development object

getVersionNumber

IGPVersionNumber getVersionNumber()

The version number of this development object

Returns:

the version of the development object

getTitle

String getTitle()

Returns the title in the original locale

Returns:

the title in the original lcoale

resolveTitle

String resolveTitle(Locale locale)
                    throws GPInvocationException

The title text in the specified locale

Parameters:

locale - the locale

Returns:

the title in the specified locale or the title in the original locale if the title is not translated to the sepcified locale

Throws:

GPInvocationException - thrown if an incorrect / no locale is passed

getDescription

String getDescription()

Returns the description in the original locale

Returns:

the description in the original locale

resolveDescription

String resolveDescription(Locale locale)
                          throws GPInvocationException

Returns the description in the specified locoale or the description in the original locale if the object is not translated.

Parameters:

locale - the locale

Returns:

the description in the specified locale or in the original locale if the object is not translated

Throws:

GPInvocationException - thrown if an incorrect / no locale is passed

getOriginalLocale

Locale getOriginalLocale()

Returns the original locale for this development object

Returns:

the original locale for this development object

getMetadata

IGPMetadata getMetadata()

Returns the development object metadata

Returns:

the development object metadata

getStatus

GPDevelopmentObjectStatus getStatus()

Returns the development object status

Returns:

the status of the development object

getType

IGPDevelopmentObjectType getType()

Returns the development object type.

Returns:

the type of the development object

getInputParameters

IGPStructureInfo getInputParameters()
                                    throws GPEngineException

Returns the input parameters definition

Returns:

the input parameters definition, in case of null it will return a default input parameters definition

Throws:

GPEngineException - thrown if the parameter definition cannot be read from the database

getOutputParameters

IGPStructureInfo getOutputParameters()
                                     throws GPEngineException

Returns the input parameters definition

Returns:

the input parameters definition, in case of null it will return a default input parameters definition

Throws:

GPEngineException - thrown if the parameter definition cannot be read from the database

getPermissions

Iterator getPermissions()

Returns all permissions that apply to the Development Object.

Returns:

an Iteration of IGPPermission objects

getCategories

String[] getCategories()

Returns the ids of the categories to which this development object is attached to

Returns:

the array of the category Ids