Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKClientExitDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKClientExitDefICM
All Implemented Interfaces:
java.io.Serializable

public class DKClientExitDefICM
extends java.lang.Object
implements java.io.Serializable

This class provides user exists for item type definition. Use this class to create a user exits object.The methods available to manage include setters and getters for user exit related entities such as DLL name, function name, to which item type or item type view the user exit belongs. This object is used in conjunction with the DKDatastoreAdminICM object to define, list, add, update and delete user exits. User exist are user defined functions that the ICM datastore maintains on behalf of the applications. An application can define these user exit functions and use them in their application and the ICM datastore only keeps these user exits on behalf of the application and does not invoke these user exit functions.

See Also:
Serialized Form

Constructor Summary
DKClientExitDefICM()
          Default Constructor
 
Method Summary
 java.lang.String getDLLName()
          Gets the dll name of this client exit object
 java.lang.String getExitName()
          Gets the exit name of this client exit object
 java.lang.String getFunctionName()
          Gets the function name of this client exit object
 int getItemTypeID()
          Gets the item type id to which this user exit object applies.
 java.lang.String getItemTypeName()
          Gets the item type name to which this client exit object applies.
 int getItemTypeViewID()
          Gets the item type view id to which this client exit object applies.
 java.lang.String getItemTypeViewName()
          Gets the item type view name of this client exit def object
 void setDLLName(java.lang.String dllName)
          Sets the dll name for this client exit object.
 void setExitName(java.lang.String exitName)
          Sets the exit name for this client exit object.
 void setFunctionName(java.lang.String funcName)
          Sets the function name for this client exit object.The function name can be up to 32 characters long.
 void setItemTypeID(int itemTypeID)
          Sets the item type id to which this user exit object applies.
 void setItemTypeName(java.lang.String itemTypeName)
          Sets the item type name for which this client exit object applies.
 void setItemTypeViewID(int itemTypeViewID)
          Sets the item type view id to which this client exit object applies.
 void setItemTypeViewName(java.lang.String itemTypeViewName)
          Sets the item type view name to which this client exit object applies.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKClientExitDefICM

public DKClientExitDefICM()
Default Constructor
Method Detail

getFunctionName

public java.lang.String getFunctionName()
Gets the function name of this client exit object
Returns:
the function name of this client exit object

setFunctionName

public void setFunctionName(java.lang.String funcName)
Sets the function name for this client exit object.The function name can be up to 32 characters long.
Parameters:
funcName - function name of the client exit object. It can up to 32 characters long.

getExitName

public java.lang.String getExitName()
Gets the exit name of this client exit object
Returns:
the exit name of this client exit object

setExitName

public void setExitName(java.lang.String exitName)
Sets the exit name for this client exit object. The exit name can be up to 40 characters.
Parameters:
exitName - exit name of the client exit object. It can up to 40 characters long.

getDLLName

public java.lang.String getDLLName()
Gets the dll name of this client exit object
Returns:
the dll name of this client exit object

setDLLName

public void setDLLName(java.lang.String dllName)
Sets the dll name for this client exit object. The DLL name can be up to 40 characters.
Parameters:
dllName - dll name of the client exit object

getItemTypeID

public int getItemTypeID()
Gets the item type id to which this user exit object applies.
Returns:
the item type id of this client exit def object.

setItemTypeID

public void setItemTypeID(int itemTypeID)
Sets the item type id to which this user exit object applies.
Parameters:
itemTypeID - - item type id

getItemTypeName

public java.lang.String getItemTypeName()
Gets the item type name to which this client exit object applies.
Returns:
the item type name to which this client exit applies

setItemTypeName

public void setItemTypeName(java.lang.String itemTypeName)
Sets the item type name for which this client exit object applies.
Parameters:
itemTypeName - - item type name for which this client exit object applies. This can be up to 32 characters long.

getItemTypeViewID

public int getItemTypeViewID()
Gets the item type view id to which this client exit object applies.
Returns:
the item type view id of this client exit object

setItemTypeViewID

public void setItemTypeViewID(int itemTypeViewID)
Sets the item type view id to which this client exit object applies.
Parameters:
itemTypeViewID - item type view id of the client exit object.

getItemTypeViewName

public java.lang.String getItemTypeViewName()
Gets the item type view name of this client exit def object
Returns:
the item type view name of this client exit def object

setItemTypeViewName

public void setItemTypeViewName(java.lang.String itemTypeViewName)
Sets the item type view name to which this client exit object applies.
Parameters:
itemTypeViewName - - item type view name to which this client exit object applies. This can be up to 32 characters long.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.