com.candle.roma.kxc
Class RomaRoute

java.lang.Object
  |
  +--com.candle.roma.kxc.RomaRoute
All Implemented Interfaces:
java.lang.Cloneable

public class RomaRoute
extends java.lang.Object
implements java.lang.Cloneable

This class defines the workflow route step.

See Also:
RomaWorkflow

Constructor Summary
RomaRoute()
          Constructs the empty object.
 
Method Summary
 java.lang.Object clone()
          Returns a copy of the object.
 int getFlags()
          Returns the route flags.
 java.lang.String getSourceFlow()
          Returns the name of the business flow that has updated the route step.
 java.lang.String getSourceOperation()
          Returns the name of the operation that has updated the route step.
 java.lang.String getSourceService()
          Returns the name of the business service that has created or updated the route step.
 java.lang.String getTargetCodePage()
          Returns the target code page.
 java.lang.String getTargetComponent()
          Returns the target business component name.
 java.lang.String getTargetElement()
          Returns the target business element name.
 java.lang.String getTargetQueue()
          Returns the target queue name.
 int getType()
          Returns the route type.
 void setFlags(int flags)
          Sets the route flags.
 void setSourceFlow(java.lang.String bf)
          Sets the name of the business flow that has updated the route step.
 void setSourceOperation(java.lang.String op)
          Sets the name of the operation that has updated the route step.
 void setSourceService(java.lang.String bs)
          Sets the name of the business service created the route step.
 void setTargetCodePage(java.lang.String cp)
          Sets the target code page.
 void setTargetComponent(java.lang.String comp)
          Sets the target business component name.
 void setTargetElement(java.lang.String elem)
          Sets the target business element name.
 void setTargetQueue(java.lang.String queue)
          Sets the target queue name.
 void setType(int type)
          Sets the route type.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RomaRoute

public RomaRoute()
Constructs the empty object.
Method Detail

getType

public int getType()
Returns the route type. This is the type of the target element in the route step.
Returns:
one of
  • Roma.APPTYPE_SERVER - the element is a server
  • Roma.APPTYPE_CLIENT - the element is a client

setType

public void setType(int type)
Sets the route type.
Parameters:
type - Target element type, one of
  • Roma.APPTYPE_SERVER - the element is a server
  • Roma.APPTYPE_CLIENT - the element is a client

getFlags

public int getFlags()
Returns the route flags.
Returns:
zero or a combination of
  • Roma.ROUTEFLAG_RESTRICTED - the target element supports only a subset of message formats
  • Roma.ROUTEFLAG_XML_ILS - the XML inline service is enabled
  • Roma.ROUTEFLAG_NOTRANSFORM - message transformation is prohibited

setFlags

public void setFlags(int flags)
Sets the route flags.
Parameters:
flags - Route flags. Should be zero or a combination of
  • Roma.ROUTEFLAG_RESTRICTED - the target element supports only a subset of message formats
  • Roma.ROUTEFLAG_XML_ILS - the XML inline service is enabled
  • Roma.ROUTEFLAG_NOTRANSFORM - message transformation is prohibited

getTargetQueue

public java.lang.String getTargetQueue()
Returns the target queue name. The format of the queue name is:
<QueueNameLo>@<QueueNameHi>@<SubNet>@<Transport>
For example:
KXCSREPLY@FFLIN@CamMq@MQSeries

setTargetQueue

public void setTargetQueue(java.lang.String queue)
Sets the target queue name.
Parameters:
queue - Queue name

getTargetElement

public java.lang.String getTargetElement()
Returns the target business element name. The target element can be a client or server.

setTargetElement

public void setTargetElement(java.lang.String elem)
Sets the target business element name. The target element can be a client or server.
Parameters:
elem - Target element name

getTargetComponent

public java.lang.String getTargetComponent()
Returns the target business component name. For a client, this is $$client.

setTargetComponent

public void setTargetComponent(java.lang.String comp)
Sets the target business component name.
Parameters:
comp - Target component name

getTargetCodePage

public java.lang.String getTargetCodePage()
Returns the target code page.

setTargetCodePage

public void setTargetCodePage(java.lang.String cp)
Sets the target code page.
Parameters:
cp - Code page name

getSourceService

public java.lang.String getSourceService()
Returns the name of the business service that has created or updated the route step. This is the business service specified on a message put call unless an application has changed it using RomaBusinessElement.buildTheme(RomaTheme,RomaThemeInfo,int,boolean) or RomaClient.buildTheme(RomaTheme,RomaThemeInfo,int,boolean) somewhere on the route, in which case this is the business service that has changed the workflow.

setSourceService

public void setSourceService(java.lang.String bs)
Sets the name of the business service created the route step.
Parameters:
bs - Business Service name

getSourceFlow

public java.lang.String getSourceFlow()
Returns the name of the business flow that has updated the route step.

setSourceFlow

public void setSourceFlow(java.lang.String bf)
Sets the name of the business flow that has updated the route step.
Parameters:
bf - Business Flow name

getSourceOperation

public java.lang.String getSourceOperation()
Returns the name of the operation that has updated the route step.

setSourceOperation

public void setSourceOperation(java.lang.String op)
Sets the name of the operation that has updated the route step.
Parameters:
op - Operation name

clone

public java.lang.Object clone()
Returns a copy of the object.
Overrides:
clone in class java.lang.Object