com.sap.caf.eu.gp.process.dt.api

Interface IGPDesigntimeManager

public interface IGPDesigntimeManager

Method Summary

IGPProcess	createProcess(String developmentObjectType, String techName, Locale originalLocale, String title, String description, String categoryId, boolean isAutomaticallyStarted, IUser user)
IGPAction	getActiveActionTemplate(String actionId, IUser user) Deprecated. Returns the active action template information for the given parameters.
IGPBlock	getActiveBlockTemplate(String blockId, IUser user) Deprecated. Returns the active block template information for the given parameters.
IGPBusinessObject	getActiveBusinessObject(String businessObjectID, IUser user) Deprecated. Returns the active business object information for the given parameters.
IGPProcessInfo[]	getActiveProcessTemplatesByCategory(String categoryId, IUser user) Deprecated. Returns information for all active process templates.
IGPProcess	getActiveTemplate(String processId, IUser user) Deprecated. Returns the active process template information for the given parameters.
IGPCategory	getCategory(String categoryId, IUser user) Deprecated. Returns the category information for the given parameters.
IGPAction	getCurrentActionTemplate(String actionId, IUser user) Deprecated. Returns the current action template information for the given parameters.
IGPBlock	getCurrentBlockTemplate(String blockId, IUser user) Deprecated. Returns the current block template information for the given parameters.
IGPBusinessObject	getCurrentBusinessObject(String businessObjectID, IUser user) Deprecated. Returns the current business object information for the given parameters.
IGPProcess	getCurrentTemplate(String processId, IUser user) Deprecated. Returns the current process template information for the given parameters.
IGPCategory	getRootCategory(IGPUserContext userContext) Returns the root category information for the given parameters.
IGPCategory	getRootCategory(IUser user, Locale locale) Deprecated. Returns the root category information for the given parameters.

Method Detail

createProcess

IGPProcess createProcess(String developmentObjectType,
                         String techName,
                         Locale originalLocale,
                         String title,
                         String description,
                         String categoryId,
                         boolean isAutomaticallyStarted,
                         IUser user)
                         throws GPEngineException,
                                GPInvocationException

Parameters:

developmentObjectType -

techName -

originalLocale -

title -

description -

categoryId -

isAutomaticallyStarted -

user - IUser NOT NULL

Returns:

Throws:

GPEngineException

GPInvocationException

getCurrentActionTemplate

IGPAction getCurrentActionTemplate(String actionId,
                                   IUser user)
                                   throws GPEngineException,
                                          GPInvocationException

Deprecated. Returns the current action template information for the given parameters.

Parameters:

actionId - String NOT NULL

user - IUser NOT NULL

Returns:

IActionTemplateInformation NOT NULL - returns ether the inactive version or the active version, if there is no inactive version.

Throws:

ProcessInformationException

GPEngineException

GPInvocationException

getActiveActionTemplate

IGPAction getActiveActionTemplate(String actionId,
                                  IUser user)
                                  throws GPEngineException,
                                         GPInvocationException

Deprecated. Returns the active action template information for the given parameters.

Parameters:

actionId - String NOT NULL

user - IUser NOT NULL

Returns:

IActionTemplateInformation - may be null if there is no active version

Throws:

ProcessInformationException

GPEngineException

GPInvocationException

getCurrentBlockTemplate

IGPBlock getCurrentBlockTemplate(String blockId,
                                 IUser user)
                                 throws GPEngineException,
                                        GPInvocationException

Deprecated. Returns the current block template information for the given parameters.

Parameters:

blockId - String NOT NULL

user - IUser NOT NULL

Returns:

IBlockTemplateInformation NOT NULL - returns ether the inactive version or the active version, if there is no inactive version.

Throws:

ProcessInformationException

GPEngineException

GPInvocationException

getActiveBlockTemplate

IGPBlock getActiveBlockTemplate(String blockId,
                                IUser user)
                                throws GPEngineException,
                                       GPInvocationException

Deprecated. Returns the active block template information for the given parameters.

Parameters:

blockId - String NOT NULL

user - IUser NOT NULL

Returns:

IBlockTemplateInformation - may be null if there is no active version

Throws:

ProcessInformationException

GPEngineException

GPInvocationException

getCurrentTemplate

IGPProcess getCurrentTemplate(String processId,
                              IUser user)
                              throws GPEngineException,
                                     GPInvocationException

Deprecated. Returns the current process template information for the given parameters.

Parameters:

processId - String NOT NULL

user - IUser NOT NULL

Returns:

ITemplateInformation - returns ether the inactive version or the active version, if there is no inactive version.

Throws:

ProcessInformationException

GPEngineException

GPInvocationException

getActiveTemplate

IGPProcess getActiveTemplate(String processId,
                             IUser user)
                             throws GPEngineException,
                                    GPInvocationException

Deprecated. Returns the active process template information for the given parameters.

Parameters:

processId - String NOT NULL

user - IUser NOT NULL

Returns:

ITemplateInformation - may be null if there is no active version

Throws:

ProcessInformationException

GPEngineException

GPInvocationException

getCategory

IGPCategory getCategory(String categoryId,
                        IUser user)
                        throws GPEngineException,
                               GPInvocationException

Deprecated. Returns the category information for the given parameters.

Parameters:

categoryId - String NOT NULL

user - IUser NOT NULL

Returns:

ICategoryInformation NOT NULL

Throws:

ProcessInformationException

GPEngineException

GPInvocationException

getRootCategory

IGPCategory getRootCategory(IUser user,
                            Locale locale)
                            throws GPEngineException,
                                   GPInvocationException

Deprecated. Returns the root category information for the given parameters.

Parameters:

locale - Locale

user - IUser NOT NULL

Returns:

ICategoryInformation NOT NULL

Throws:

ProcessInformationException

GPEngineException

GPInvocationException

getRootCategory

IGPCategory getRootCategory(IGPUserContext userContext)
                            throws GPEngineException,
                                   GPInvocationException

Returns the root category information for the given parameters.

Parameters:

userContext - IGPUserContext NOT NULL

Returns:

ICategoryInformation NOT NULL

Throws:

ProcessInformationException

GPEngineException

GPInvocationException

getCurrentBusinessObject

IGPBusinessObject getCurrentBusinessObject(String businessObjectID,
                                           IUser user)
                                           throws GPEngineException,
                                                  GPInvocationException

Deprecated. Returns the current business object information for the given parameters.

Parameters:

businessObjectID - String NOT NULL

user - IUser NOT NULL

Returns:

NOT NULL - returns ether the inactive version or the active version, if there is no inactive version.

Throws:

GPEngineException

GPInvocationException

getActiveBusinessObject

IGPBusinessObject getActiveBusinessObject(String businessObjectID,
                                          IUser user)
                                          throws GPEngineException,
                                                 GPInvocationException

Deprecated. Returns the active business object information for the given parameters.

Parameters:

businessObjectID - String NOT NULL

user - IUser NOT NULL

Returns:

may be NULL - returns the active version, if there is one.

Throws:

GPEngineException

GPInvocationException

getActiveProcessTemplatesByCategory

IGPProcessInfo[] getActiveProcessTemplatesByCategory(String categoryId,
                                                     IUser user)
                                                     throws GPEngineException,
                                                            GPInvocationException

Deprecated. Returns information for all active process templates.

Parameters:

categoryId -

user - IUser NOT NULL

Returns:

ITemplateInformation[] NOT NULL

Throws:

GPEngineException

GPInvocationException