com.sap.netweaver.bc.uwl.admin

Interface IWebflowConfigurationAdmin


public interface IWebflowConfigurationAdmin

This interface defined methods for maintaining Webflow a.k.a Business Workflow systems.


Nested Class Summary
static class IWebflowConfigurationAdmin.R3System
          class to encapsulate r3 system id, and r3 client
static class IWebflowConfigurationAdmin.Result
          Class that represnts result of registering a webflow configuration
static class IWebflowConfigurationAdmin.SystemInfo
           
 
Method Summary
 Collection getAttributesForObjectType(String objectType, UWLContext uwlContext, String system)
          Fires SWO_QUERY_ATTRIBUTES to get the attributes
 String getObjectTypeFortaskID(String taskID, UWLContext uwlContext, String system)
          Fires transaction RH_READ_HRS1201 to get the object type for a task ID.
 IWebflowConfigurationAdmin.R3System getR3System(String alias)
          returns R3System object for a given portal system alias
 IWebflowConfigurationAdmin.SystemInfo[] getSystems(IUWLConfigurationAdmin configAdmin)
           
 boolean isConfiguredForOptimizedPull(UWLContext context, String system)
          Check if the backend system is configured for the optimized delta pull, i.e., the batch job is started
 IWebflowConfigurationAdmin.Result loadConfiguration(UWLContext context, IUWLConfigurationAdmin configAdmin, boolean onlyNewSystems)
           
 IWebflowConfigurationAdmin.Result loadConfiguration(UWLContext context, IUWLConfigurationAdmin configAdmin, HashMap systemsToConfigure)
           
 boolean supportsOptimizedPull(UWLContext context, String system, String connector)
          Check if the backend system supports the optimized delta pull
 

Method Detail

loadConfiguration

public IWebflowConfigurationAdmin.Result loadConfiguration(UWLContext context,
                                                           IUWLConfigurationAdmin configAdmin,
                                                           boolean onlyNewSystems)
                                                    throws UWLException
Parameters:
context -
configAdmin -
onlyNewSystems - if true only systems which are not registerd are considered for generating the configuration.
Returns:
not null
Throws:
UWLException

loadConfiguration

public IWebflowConfigurationAdmin.Result loadConfiguration(UWLContext context,
                                                           IUWLConfigurationAdmin configAdmin,
                                                           HashMap systemsToConfigure)
                                                    throws UWLException
Parameters:
context -
configAdmin -
systemsToConfigure - a set of webflow and alert systems to configure.
Returns:
not null
Throws:
UWLException

isConfiguredForOptimizedPull

public boolean isConfiguredForOptimizedPull(UWLContext context,
                                            String system)
                                     throws ConnectorException
Check if the backend system is configured for the optimized delta pull, i.e., the batch job is started

Parameters:
context -
system - - the Portal system alias of the system for which the check is to be done
Returns:
Throws:
ConnectorException

supportsOptimizedPull

public boolean supportsOptimizedPull(UWLContext context,
                                     String system,
                                     String connector)
                              throws ConnectorException
Check if the backend system supports the optimized delta pull

Parameters:
context -
system - - the Portal system alias of the system for which the check is to be done
Returns:
Throws:
ConnectorException

getSystems

public IWebflowConfigurationAdmin.SystemInfo[] getSystems(IUWLConfigurationAdmin configAdmin)
                                                   throws UWLException
Returns:
system information. See SystemInfo for details
Throws:
UWLException

getAttributesForObjectType

public Collection getAttributesForObjectType(String objectType,
                                             UWLContext uwlContext,
                                             String system)
                                      throws ConnectorException
Fires SWO_QUERY_ATTRIBUTES to get the attributes

Parameters:
objectType -
Returns:
Throws:
ConnectorException

getObjectTypeFortaskID

public String getObjectTypeFortaskID(String taskID,
                                     UWLContext uwlContext,
                                     String system)
                              throws ConnectorException
Fires transaction RH_READ_HRS1201 to get the object type for a task ID.

Parameters:
taskID - task ID for which the item type is fetched.
uwlContext -
Throws:
ConnectorException

getR3System

public IWebflowConfigurationAdmin.R3System getR3System(String alias)
returns R3System object for a given portal system alias



Copyright 2006 SAP AG Complete Copyright Notice