registerInterface method

Description

Registers a FunctionCall object with the IFX Manager.

Method


public void registerInterface(
   com.ibm.form.api.GenericInterface theInterface,
   String theInterfaceName,
   int theInterfaceVersion,
   int theMinInterfaceVersion,
   int theImplementationVersion,
   int theFlags,
   String [] theCriteriaList,
   com.ibm.form.api.ifx.IFXCriteriaMatchingHandler theCriteriaHandler
  ) throws UWIException;

Parameters

Expression	Type	Description
`theInterface`	GenericInterface	The object that you are registering with the IFX Manager. Typical setting: this (if the object is registering itself)
`theInterfaceName`	String	The name of the Interface that you are registering. In this case a Function Call Interface. Typical setting: FunctionCall.FUNCTIONCALL_INTERFACE_ NAME
`theInterfaceVersion`	int	The function call interface version. Typical setting: FunctionCall.FUNCTIONCALL_CURRENT_ VERSION
`theMinInterface Version`	int	The minimum version that the interface will support. Typical setting: FunctionCall.FUNCTIONCALL_ MIN_VERSION_SUPPORTED
`theImplementation Version`	int	The version of the object you are registering. This is typically 0x01000300. If there are multiple objects with the same name available, the one with the highest version number is registered.
`theFlags`	int	Reserved. Setting: 0
`theCriteriaList`	String [ ]	Reserved. Setting: null
`theCriteriaHandler`	com.ibm.form.api.ifx.IFX Criteria-Matching Handler	Reserved. Setting: theFCM.getDefaultListener( )

Returns

Nothing if call is successful or throws a generic exception (UWIException) if an error occurs.

Usage Details

Typically, you will have to retrieve the Function Call Manager from the IFX Manager using getFunctionCallManager before you call registerInterface.
Typically the registerInterface parameter called theCriteriaHandler is set to:
```
      theFCM.getDefaultListener( )
```

Note that theFCM is a FunctionCallManager object which represents the Function Call Manager.

Example

In the following example, theIFX represents the IFX Manager

   public FciFunctionCall(IFX IFXMan) throws UWIException
      {
      FunctionCallManager theFCM;
         if ((theFCM = IFSSingleton.getFunctionCallManager()) == null) 
            throw new UWIException("Needed Function Call Manager");
         IFXMan.registerInterface(this, 
            FunctionCall.FUNCTIONCALL_INTERFACE_NAME,
            FunctionCall.FUNCTIONCALL_CURRENT_VERSION,
            FunctionCall.FUNCTIONCALL_MIN_VERSION_SUPPORTED, 
            0x01000300, 0, null, theFCM.getDefaultListener( ));
      }