|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sun.emp.cci.eci.ECIInteractionSpec
The specification of an ECI interaction.
This class is a Java Bean.
Field Summary | |
static int |
UNSPECIFIED_COMMAREA_LENGTH
A value to be used for the commArea property when the
application wishes for the commarea length to be derived from the
input record. |
Fields inherited from interface javax.resource.cci.InteractionSpec |
SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE |
Constructor Summary | |
ECIInteractionSpec()
Create an interaction spec. |
Method Summary | |
void |
addPropertyChangeListener(PropertyChangeListener pcl)
Add a property change listener for all of the bound properties of this object. |
void |
addPropertyChangeListener(String propName,
PropertyChangeListener pcl)
Add a property change listener for a named bound property of this object. |
int |
getCommareaLength()
Get the value of the commarea length. |
String |
getFunctionName()
Get the name of the MTP program to execute. |
int |
getInteractionVerb()
Get the current interaction verb. |
void |
removePropertyChangeListener(PropertyChangeListener pcl)
Remove a property change listener for all of the bound properties of this object. |
void |
removePropertyChangeListener(String propName,
PropertyChangeListener pcl)
Add a property change listener for a named bound property of this object. |
void |
setCommareaLength(int caLen)
Set the length of the commarea to use. |
void |
setFunctionName(String mtpProgName)
Set the name of the MTP program to execute. |
void |
setInteractionVerb(int iv)
Set the interaction verb for this interaction. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int UNSPECIFIED_COMMAREA_LENGTH
commArea
property when the
application wishes for the commarea length to be derived from the
input record.
setCommareaLength(int)
,
getCommareaLength()
,
Constant Field ValuesConstructor Detail |
public ECIInteractionSpec()
The default values for the properties of this object are:
interactionVerb
- SYNC_SEND_RECEIVE
functionName
- blankcommareaLength
- UNSPECIFIED_COMMAREA_LENGTH
Method Detail |
public void addPropertyChangeListener(PropertyChangeListener pcl)
pcl
- The listenerpublic void addPropertyChangeListener(String propName, PropertyChangeListener pcl)
propName
- The name of the propertypcl
- The listenerpublic void removePropertyChangeListener(PropertyChangeListener pcl)
pcl
- The listenerpublic void removePropertyChangeListener(String propName, PropertyChangeListener pcl)
propName
- The name of the propertypcl
- The listenerpublic void setInteractionVerb(int iv)
Only SYNC_SEND_RECEIVE
is supported.
iv
- The interaction verb.
IllegalArgumentException
- if the verb is not
SYNC_SEND_RECEIVE
.getInteractionVerb()
public int getInteractionVerb()
This will always return SYNC_SEND_RECEIVE
for this
release.
SYNC_SEND_RECEIVE
)setInteractionVerb(int)
public void setFunctionName(String mtpProgName)
If the supplied program name is longer than 8 characters in length, then the name will be truncated to 8 characters when the interaction is actually executed.
NullPointerException
- if the program name is nullgetFunctionName()
public String getFunctionName()
setFunctionName(java.lang.String)
public void setCommareaLength(int caLen)
The commarea length specified here is an override value to the
commarea lengths derived from the Record
supplied to
the interaction. If a valid commarea length is specified, then
it signifies the amount of data send to and from the server in an
interaction. If it is not specified, then the amount of data is
derived from the input Record
length.
In order to use the Recorder
derived value, a parameter
of UNSPECIFIED_COMMAREA_LENGTH
should be used.
Other that the above special value, the commarea length must be >=0 and <32500.
caLen
- The length of the commarea (in bytes).
IllegalArgumentException
- if
calen
is not a valid value ( see above ).getCommareaLength()
public int getCommareaLength()
The special value of UNSPECIFIED_COMMAREA_LENGTH
can
be returned.
setCommareaLength(int)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |