com.ibm.tivoli.maximo.interaction.process

Class InteractionInfo

java.lang.Object

com.ibm.tivoli.maximo.interaction.process.InteractionInfo

public final class InteractionInfo
extends java.lang.Object

Holds information about the Interaction and it's mapping

Constructor Summary

Constructors

Constructor and Description

InteractionInfo(java.lang.String interactionName, java.lang.String description, java.lang.String appName, int applyResponse, java.lang.String mapOption, java.lang.String intObject, byte[] obp, java.lang.String channelName, java.lang.String reqRelation, java.lang.String respRelation, java.lang.String intMode, java.lang.String dialogId, java.lang.String requestMappingClass, java.lang.String responseMappingClass, int commitResponse, int showSingleResponse, int active, int genMenuOption) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	applyResponse() Returns is reply needs to be applied back to application
boolean	generateMenuOption() Returns is menu option generated
java.util.Map	getAllObjects(java.lang.String osName) Object mapping for the interaction object
java.lang.String	getAppName() Returns application name
java.lang.String	getChannelName() Get invocation channel name
java.lang.String	getDescription() Returns interaction description
java.lang.String	getDialogId() Get dialog id
java.lang.String	getInteractionName() Returns interaction name
java.lang.String	getIntMainObject() Returns interaction main object
java.lang.String	getIntMode() Get interaction mode
java.lang.String	getMapOption() Returns application sigoption
IntMappingInfo	getObjectMapping(java.lang.String osName, java.lang.String hpath) Object mapping for the interaction object and hierarachypath
java.util.Map	getObjectStructure() All mapping for an interaction
byte[]	getObp() Returns interaction OBP
java.lang.String	getReqRelation() Get relationship from application object to interaction request object
java.lang.String	getRequestMappingClass() Returns request mapping class
java.lang.String	getRequestOSName() Returns request object structure name
java.lang.String	getResponseMappingClass() Returns response mapping class
java.lang.String	getResponseOSName() Returns response object structure name
java.lang.String	getRespRelation() Get relationship from interaction request object to interaction response object
boolean	isActive() Returns is interaction active
boolean	isCommitResponse() Returns indicator to commit response back to application
void	setRequestOSName(java.lang.String mosName) set RequestOSName
void	setResponseOSName(java.lang.String mosName) set tResponseOSName
boolean	showSingleResponse() Returns indicator to show data in response dialog if only one row for primary Object is returned from Web Service invocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InteractionInfo

public InteractionInfo(java.lang.String interactionName,
                       java.lang.String description,
                       java.lang.String appName,
                       int applyResponse,
                       java.lang.String mapOption,
                       java.lang.String intObject,
                       byte[] obp,
                       java.lang.String channelName,
                       java.lang.String reqRelation,
                       java.lang.String respRelation,
                       java.lang.String intMode,
                       java.lang.String dialogId,
                       java.lang.String requestMappingClass,
                       java.lang.String responseMappingClass,
                       int commitResponse,
                       int showSingleResponse,
                       int active,
                       int genMenuOption)

Constructor

Parameters:

interactionName - - interaction name

description - - interaction description

appName - - application name

applyResponse - - is reply needs to be applied back to application

mapOption - - application sigoption

intObject - - interaction main object

obp - - byte representataion of optimized obp

channelName - - invokation channel name

reqRelation - - relationship from application object to interaction request object

respRelation - - relationship from interaction request object to interaction response object

intMode - - interaction mode

dialogId - - name of the dialog which was generated for this interaction

requestMappingClass - - request mapping class

responseMappingClass - - response mapping class

commitResponse - - commit response

showSingleResponse - - show single response in response dialog

active - - is interaction active

genMenuOption - - is menu option generated

Method Detail

getChannelName

public java.lang.String getChannelName()

Get invocation channel name

Returns:

invocation channel name

getReqRelation

public java.lang.String getReqRelation()

Get relationship from application object to interaction request object

Returns:

request relation

getRespRelation

public java.lang.String getRespRelation()

Get relationship from interaction request object to interaction response object

Returns:

response relation

getIntMode

public java.lang.String getIntMode()

Get interaction mode

Returns:

interaction mode

getDialogId

public java.lang.String getDialogId()

Get dialog id

Returns:

dialog id

getMapOption

public java.lang.String getMapOption()

Returns application sigoption

Returns:

application sigoption

getIntMainObject

public java.lang.String getIntMainObject()

Returns interaction main object

Returns:

interaction main object

getObp

public byte[] getObp()

Returns interaction OBP

Returns:

OBP

getDescription

public java.lang.String getDescription()

Returns interaction description

Returns:

interaction description

getRequestOSName

public java.lang.String getRequestOSName()

Returns request object structure name

Returns:

request object structure name

getResponseOSName

public java.lang.String getResponseOSName()

Returns response object structure name

Returns:

response object structure name

getRequestMappingClass

public java.lang.String getRequestMappingClass()

Returns request mapping class

Returns:

request mapping class

getResponseMappingClass

public java.lang.String getResponseMappingClass()

Returns response mapping class

Returns:

response mapping class

getAppName

public java.lang.String getAppName()

Returns application name

Returns:

application name

getInteractionName

public java.lang.String getInteractionName()

Returns interaction name

Returns:

interaction name

applyResponse

public boolean applyResponse()

Returns is reply needs to be applied back to application

Returns:

apply response

generateMenuOption

public boolean generateMenuOption()

Returns is menu option generated

Returns:

is menu option generated

isCommitResponse

public boolean isCommitResponse()

Returns indicator to commit response back to application

Returns:

commit response

isActive

public boolean isActive()

Returns is interaction active

Returns:

aqctive flag

showSingleResponse

public boolean showSingleResponse()

Returns indicator to show data in response dialog if only one row for primary Object is returned from Web Service invocation

Returns:

show single response

getObjectStructure

public java.util.Map getObjectStructure()

All mapping for an interaction

Returns:

map of IntMappingInfo object maps

getAllObjects

public java.util.Map getAllObjects(java.lang.String osName)

Object mapping for the interaction object

Parameters:

osName - - object structure name

Returns:

map of IntMappingInfo object

getObjectMapping

public IntMappingInfo getObjectMapping(java.lang.String osName,
                                       java.lang.String hpath)

Object mapping for the interaction object and hierarachypath

Parameters:

osName - - object structure name

hpath - hierarchypath

Returns:

IntMappingInfo object

setRequestOSName

public void setRequestOSName(java.lang.String mosName)

set RequestOSName

setResponseOSName

public void setResponseOSName(java.lang.String mosName)

set tResponseOSName