com.sap.caf.eu.gp.forms.api

Interface IFormTemplateInfo

public interface IFormTemplateInfo

Provides form template configuration info.

Method Summary

String	getDescription() Returns template description in the original language.
IGPStructureInfo	getFormContextStructure() Returns structure info of the form template context
int	getGlobalActiveVersionNumber() Returns global version number of the active version of the template
int	getGlobalVersionNumber() Returns global version number of the template version
int	getLocalActiveVersionNumber() Returns local version number of the active version of the template
int	getLocalVersionNumber() Returns local version number of the template version
Locale	getOriginalLocale() Returns the original locale of the form template.
Enumeration	getPrefillingServicesInputStructureInfo() Returns an Enumeration of IGPStructureInfo values one for each pre-filling services.
String	getTemplateID() Returns the template ID
String	getTemplateType() Returns template type
String	resolveDescription(Locale locale) Resolves the description.

Method Detail

getTemplateID

public String getTemplateID()

Returns the template ID

getGlobalVersionNumber

public int getGlobalVersionNumber()

Returns global version number of the template version

getLocalVersionNumber

public int getLocalVersionNumber()

Returns local version number of the template version

getGlobalActiveVersionNumber

public int getGlobalActiveVersionNumber()

Returns global version number of the active version of the template

getLocalActiveVersionNumber

public int getLocalActiveVersionNumber()

Returns local version number of the active version of the template

getFormContextStructure

public IGPStructureInfo getFormContextStructure()

Returns structure info of the form template context

getPrefillingServicesInputStructureInfo

public Enumeration getPrefillingServicesInputStructureInfo()

Returns an Enumeration of IGPStructureInfo values one for each pre-filling services.

getTemplateType

public String getTemplateType()

Returns template type

getOriginalLocale

public Locale getOriginalLocale()

Returns the original locale of the form template.

Returns:

locale

getDescription

public String getDescription()

Returns template description in the original language.

Returns:

decription

resolveDescription

public String resolveDescription(Locale locale)
                          throws GPInvocationException,
                                 GPEngineException

Resolves the description.

Parameters:

locale - the preferred language to get the description in

Returns:

the resolved description

Throws:

GPInvocationException

GPEngineException