EnterpriseServiceInfo (Maximo API)

java.lang.Object
- psdi.iface.mic.EnterpriseServiceInfo

public final class EnterpriseServiceInfo
extends java.lang.Object

Holds Information about MAXIFACEIN table in memory

Constructor Summary

Constructors
Constructor and Description

EnterpriseServiceInfo()

Constructors
Constructor and Description
`EnterpriseServiceInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTypeProperty(int isXMLTag, java.lang.String param, java.lang.String value)` Adds the type property
`protected void`	`createInterpreter()` Creates the Interpreter
`java.lang.String`	`getElementName()` Get the reply Element name for schema
`java.lang.String`	`getExitClassName()` Get the Exit Class Name
`java.lang.String`	`getExtMsgIDField()` Get the External Message ID Field
`java.lang.String`	`getIfacecontrol()` Get the multiplication control
`int`	`getIfaceMapOrder()` Get the iface Map Order
`java.lang.String`	`getIfaceName()` Return the service name
`java.lang.String`	`getIfaceTbName()` Get the Interface Table Name
`java.lang.String`	`getIfaceType()` Return the service type
`Interpreter`	`getInterpreter()` Returns the interpreter
`java.lang.String`	`getInterpreterClassName()` Get the Interpreter class name
`java.lang.String`	`getMapName()` Get the XSL Map Name
`java.lang.String`	`getMessageType()` Get the message type
`java.lang.String`	`getMosName()` Return the name of object structure
`java.util.Map`	`getNamespaces()` Get namespaces map
`java.lang.String`	`getReplyElementName()` Get the reply element name for schema
`java.lang.String`	`getReplyExitClass()` Get the Reply Exit Class Name
`java.lang.String`	`getReplyMapName()` Get the Reply XSL Map Name
`java.lang.String`	`getReplySchemaLocation()` Get the reply schema file name
`java.lang.String`	`getReplyUserExitClass()` Get the Reply Iface Type
`java.lang.String`	`getSchemaLocation()` Get the schema file name
`java.lang.String`	`getSearchField()` Get the External Message ID Field
`java.lang.String`	`getSplitTag()` Get split tag name
`java.util.List`	`getTypeProperties()` Returns a List of properties associated with this ifacetype as `psdi.iface.mic.EnterpriseServicePropInfo` objects
`java.lang.String`	`getUserExitClassName()` Get the User Exit Class Name
`boolean`	`isPrimaryMos()` Returns is primary object structure for this service
`boolean`	`isReplyRequired()` Returns is reply required for this service
`boolean`	`isStoreMsg()` Returns if Transaction Storing is ON or OFF for this service
`boolean`	`isTxnTrkEnabled()` Returns if Transaction Tracking is ON or OFF for this service
`protected void`	`setDefaultNamespace()` Set default namespace from mxe.int.xmlnamespace property
`protected void`	`setDefaultSplitTag(java.lang.String msg, java.lang.String os)` Set default split tag name
`protected void`	`setElementName(java.lang.String rc)` Set the reply Element name for schema
`protected void`	`setExitClassName(java.lang.String exitClassName)` Set the Exit Class Name
`protected void`	`setExtMsgIDField(java.lang.String extMsgIDField)` Set the External Message ID Field which is used in case of Transaction Tracking This field acts a key while tracking a given transation.
`protected void`	`setIfacecontrol(java.lang.String string)` Set the multiplication control
`protected void`	`setIfaceMapOrder(int ifaceMapOrder)` Set the iface Map Order
`protected void`	`setIfaceName(java.lang.String e)` Set the service name
`protected void`	`setIfaceTbName(java.lang.String string)` Set the Interface Table Name
`protected void`	`setIfaceType(java.lang.String e)` Set the service type
`protected void`	`setInterpreterClassName(java.lang.String interpreterClassName)` Set the Interpreter class name
`protected void`	`setMapName(java.lang.String mapName)` Set the XSL Map Name
`protected void`	`setMessageType(java.lang.String string)` Set the message type
`protected void`	`setMosName(java.lang.String c)` Set the name of object structure
`protected void`	`setPrimaryMos(boolean b)` Set whether primary object structure for this service
`protected void`	`setReplyElementName(java.lang.String rc)` Set the reply element name for schema
`protected void`	`setReplyExitClass(java.lang.String c)` Set the Reply Exit Class Name
`protected void`	`setReplyMapName(java.lang.String c)` Set the Reply XSL Map Name
`protected void`	`setReplySchemaLocation(java.lang.String rc)` Set the reply schema file name
`protected void`	`setReplyUserExitClass(java.lang.String c)` Set the Reply User Exit Class Name
`protected void`	`setSchemaLocation(java.lang.String rc)` Set the Schema File name
`protected void`	`setSearchField(java.lang.String searchField)` Set the Search ID Field which is used in case of Transaction Tracking.
`protected void`	`setSplitTag(java.lang.String st)` Set the split tag name
`protected void`	`setStoreMsg(int storeMsgVal)` Sets flag indicating where to store Transaction or not for this service
`protected void`	`setTxnTrkEnabled(int txnTrkEnabledVal)` Sets Transaction Tracking flag for this service
`protected void`	`setUseExternalSchema(int def)` Set whether service use external or internal schema
`protected void`	`setUserExitClassName(java.lang.String userExitClassName)` Set the User Exit Class Name
`boolean`	`useExternalSchema()` Returns whether service use external or internal schema

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EnterpriseServiceInfo
```
public EnterpriseServiceInfo()
```
- Method Detail
  - getMosName
```
public java.lang.String getMosName()
```
    Return the name of object structure
    
    Returns:
    
    object structure name
  - setMosName
```
protected void setMosName(java.lang.String c)
```
    Set the name of object structure
    
    Parameters:
    
    c - object structure name
  - getIfaceName
```
public java.lang.String getIfaceName()
```
    Return the service name
    
    Returns:
    
    service name
  - setIfaceName
```
protected void setIfaceName(java.lang.String e)
```
    Set the service name
    
    Parameters:
    
    e - service name
  - getIfaceType
```
public java.lang.String getIfaceType()
```
    Return the service type
    
    Returns:
    
    service type
  - setIfaceType
```
protected void setIfaceType(java.lang.String e)
```
    Set the service type
    
    Parameters:
    
    e - service type
  - setUseExternalSchema
```
protected void setUseExternalSchema(int def)
```
    Set whether service use external or internal schema
    
    Parameters:
    
    def - external or internal schema
  - useExternalSchema
```
public boolean useExternalSchema()
```
    Returns whether service use external or internal schema
    
    Returns:
    
    true or false
  - setSchemaLocation
```
protected void setSchemaLocation(java.lang.String rc)
```
    Set the Schema File name
    
    Parameters:
    
    rc - Schema file name
  - getSchemaLocation
```
public java.lang.String getSchemaLocation()
```
    Get the schema file name
    
    Returns:
    
    Schema file Name
  - setElementName
```
protected void setElementName(java.lang.String rc)
```
    Set the reply Element name for schema
    
    Parameters:
    
    rc - reply Interface Name
  - getElementName
```
public java.lang.String getElementName()
```
    Get the reply Element name for schema
    
    Returns:
    
    reply Element name for schema
  - isReplyRequired
```
public boolean isReplyRequired()
                        throws MXException,
                               java.rmi.RemoteException
```
    Returns is reply required for this service
    
    Returns:
    
    true or false
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - setPrimaryMos
```
protected void setPrimaryMos(boolean b)
```
    Set whether primary object structure for this service
    
    Parameters:
    
    b - primary object structure flag indicating whether the object structure is primary for this service
  - isPrimaryMos
```
public boolean isPrimaryMos()
```
    Returns is primary object structure for this service
    
    Returns:
    
    true or false
  - setReplySchemaLocation
```
protected void setReplySchemaLocation(java.lang.String rc)
```
    Set the reply schema file name
    
    Parameters:
    
    rc - reply schema file name
  - getReplySchemaLocation
```
public java.lang.String getReplySchemaLocation()
```
    Get the reply schema file name
    
    Returns:
    
    reply schema file name
  - setReplyElementName
```
protected void setReplyElementName(java.lang.String rc)
```
    Set the reply element name for schema
    
    Parameters:
    
    rc - reply element name for schema
  - getReplyElementName
```
public java.lang.String getReplyElementName()
```
    Get the reply element name for schema
    
    Returns:
    
    reply element name for schema
  - setExitClassName
```
protected void setExitClassName(java.lang.String exitClassName)
```
    Set the Exit Class Name
    
    Parameters:
    
    exitClassName - Exit Class Name
  - getExitClassName
```
public java.lang.String getExitClassName()
```
    Get the Exit Class Name
    
    Returns:
    
    the Exit Class Name
  - setUserExitClassName
```
protected void setUserExitClassName(java.lang.String userExitClassName)
```
    Set the User Exit Class Name
    
    Parameters:
    
    userExitClassName - the User Exit Class Name
  - getUserExitClassName
```
public java.lang.String getUserExitClassName()
```
    Get the User Exit Class Name
    
    Returns:
    
    User Exit Class Name
  - getMapName
```
public java.lang.String getMapName()
```
    Get the XSL Map Name
    
    Returns:
    
    the XSL Map Name
  - setMapName
```
protected void setMapName(java.lang.String mapName)
```
    Set the XSL Map Name
    
    Parameters:
    
    mapName - XSL Map Name
  - getReplyExitClass
```
public java.lang.String getReplyExitClass()
```
    Get the Reply Exit Class Name
    
    Returns:
    
    Reply Exit Class Name
  - setReplyExitClass
```
protected void setReplyExitClass(java.lang.String c)
```
    Set the Reply Exit Class Name
    
    Parameters:
    
    c - Reply Exit Class Name
  - getReplyUserExitClass
```
public java.lang.String getReplyUserExitClass()
```
    Get the Reply Iface Type
    
    Returns:
    
    Reply Iface Type
  - setReplyUserExitClass
```
protected void setReplyUserExitClass(java.lang.String c)
```
    Set the Reply User Exit Class Name
    
    Parameters:
    
    c - Reply User Exit Class Name
  - getReplyMapName
```
public java.lang.String getReplyMapName()
```
    Get the Reply XSL Map Name
    
    Returns:
    
    Reply XSL Map Name
  - setReplyMapName
```
protected void setReplyMapName(java.lang.String c)
```
    Set the Reply XSL Map Name
    
    Parameters:
    
    c - Reply XSL Map Name
  - getIfaceTbName
```
public java.lang.String getIfaceTbName()
```
    Get the Interface Table Name
    
    Returns:
    
    Interface Table Name
  - setIfaceTbName
```
protected void setIfaceTbName(java.lang.String string)
```
    Set the Interface Table Name
    
    Parameters:
    
    string - Interface Table Name
  - getMessageType
```
public java.lang.String getMessageType()
```
    Get the message type
    
    Returns:
    
    the message type
  - setMessageType
```
protected void setMessageType(java.lang.String string)
```
    Set the message type
    
    Parameters:
    
    string - the message type
  - getIfacecontrol
```
public java.lang.String getIfacecontrol()
```
    Get the multiplication control
    
    Returns:
    
    multiplication control
  - setIfacecontrol
```
protected void setIfacecontrol(java.lang.String string)
```
    Set the multiplication control
    
    Parameters:
    
    string - multiplication control
  - getIfaceMapOrder
```
public int getIfaceMapOrder()
```
    Get the iface Map Order
    
    Returns:
    
    iface Map Order
  - setIfaceMapOrder
```
protected void setIfaceMapOrder(int ifaceMapOrder)
```
    Set the iface Map Order
    
    Parameters:
    
    ifaceMapOrder - the iface map order
  - setInterpreterClassName
```
protected void setInterpreterClassName(java.lang.String interpreterClassName)
```
    Set the Interpreter class name
    
    Parameters:
    
    interpreterClassName - Interpreter class name
  - getInterpreterClassName
```
public java.lang.String getInterpreterClassName()
```
    Get the Interpreter class name
    
    Returns:
    
    Interpreter class name
  - setDefaultNamespace
```
protected void setDefaultNamespace()
                            throws MXException,
                                   java.rmi.RemoteException
```
    Set default namespace from mxe.int.xmlnamespace property
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - setSplitTag
```
protected void setSplitTag(java.lang.String st)
```
    Set the split tag name
    
    Parameters:
    
    st - split tag name
  - setDefaultSplitTag
```
protected void setDefaultSplitTag(java.lang.String msg,
                                  java.lang.String os)
                           throws MXException,
                                  java.rmi.RemoteException
```
    Set default split tag name
    
    Parameters:
    
    msg - default split tag name value
    
    os - object structure name
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - getSplitTag
```
public java.lang.String getSplitTag()
                             throws MXException,
                                    java.rmi.RemoteException
```
    Get split tag name
    
    Returns:
    
    split tag name
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - getNamespaces
```
public java.util.Map getNamespaces()
```
    Get namespaces map
    
    Returns:
    
    map of all namespaces
  - addTypeProperty
```
public void addTypeProperty(int isXMLTag,
                            java.lang.String param,
                            java.lang.String value)
```
    Adds the type property
    
    Parameters:
    
    isXMLTag - is this an xml tag
    
    param - parameter name
    
    value - parameter value
  - getInterpreter
```
public Interpreter getInterpreter()
                           throws MXException
```
    Returns the interpreter
    
    Returns:
    
    Interpreter
    
    Throws:
    
    MXException
  - createInterpreter
```
protected void createInterpreter()
                          throws MXException
```
    Creates the Interpreter
    
    Throws:
    
    MXException
  - getTypeProperties
```
public java.util.List getTypeProperties()
```
    Returns a List of properties associated with this ifacetype as psdi.iface.mic.EnterpriseServicePropInfo objects
    
    Returns:
    
    List of psdi.iface.mic.EnterpriseServicePropInfo objects
  - setTxnTrkEnabled
```
protected void setTxnTrkEnabled(int txnTrkEnabledVal)
```
    Sets Transaction Tracking flag for this service
    
    Parameters:
    
    txnTrkEnabledVal - flag indicating Transaction Tracking for this service
  - isTxnTrkEnabled
```
public boolean isTxnTrkEnabled()
```
    Returns if Transaction Tracking is ON or OFF for this service
    
    Returns:
    
    true or false
  - setStoreMsg
```
protected void setStoreMsg(int storeMsgVal)
```
    Sets flag indicating where to store Transaction or not for this service
    
    Parameters:
    
    storeMsgVal - flag indicating storage of Transaction in case of Tranaction Tracking for this service
  - isStoreMsg
```
public boolean isStoreMsg()
```
    Returns if Transaction Storing is ON or OFF for this service
    
    Returns:
    
    true or false
  - setExtMsgIDField
```
protected void setExtMsgIDField(java.lang.String extMsgIDField)
```
    Set the External Message ID Field which is used in case of Transaction Tracking This field acts a key while tracking a given transation.
    
    Parameters:
    
    extMsgIDField - External Message ID Field (serves as key field)
  - getExtMsgIDField
```
public java.lang.String getExtMsgIDField()
```
    Get the External Message ID Field
    
    Returns:
    
    External Message ID Field
  - setSearchField
```
protected void setSearchField(java.lang.String searchField)
```
    Set the Search ID Field which is used in case of Transaction Tracking. This field is in addition to the key(EXTMSGIDFIELD) field in order to make searching a given message easier. This field can be typically used when user can not give a more intuitive EXTMSGIDFIELD but some other field is more useful in looking for a message status (e.g. PONUM)
    
    Parameters:
    
    searchField - Search Field (serves as more user friedly alternative to key field)
  - getSearchField
```
public java.lang.String getSearchField()
```
    Get the External Message ID Field
    
    Returns:
    
    External Message ID Field

Methods inherited from class java.lang.Object

EnterpriseServiceInfo

getMosName

setMosName

getIfaceName

setIfaceName

getIfaceType

setIfaceType

setUseExternalSchema

useExternalSchema

setSchemaLocation

getSchemaLocation

setElementName

getElementName

isReplyRequired

setPrimaryMos

isPrimaryMos

setReplySchemaLocation

getReplySchemaLocation

setReplyElementName

getReplyElementName

setExitClassName

getExitClassName

setUserExitClassName

getUserExitClassName

getMapName

setMapName

getReplyExitClass

setReplyExitClass

getReplyUserExitClass

setReplyUserExitClass

getReplyMapName

setReplyMapName

getIfaceTbName

setIfaceTbName

getMessageType

setMessageType

getIfacecontrol

setIfacecontrol

getIfaceMapOrder

setIfaceMapOrder

setInterpreterClassName

getInterpreterClassName

setDefaultNamespace

setSplitTag

setDefaultSplitTag

getSplitTag

getNamespaces

addTypeProperty

getInterpreter

createInterpreter

getTypeProperties

setTxnTrkEnabled

isTxnTrkEnabled

setStoreMsg

isStoreMsg

setExtMsgIDField

getExtMsgIDField

setSearchField

getSearchField