A B C D E F G H I L M N O P Q R S T U W

A

ACTION_ALERT - Static variable in interface com.candle.roma.kxc.Roma
Error analysis routine should send an alert.
ACTION_DEFAULT - Static variable in interface com.candle.roma.kxc.Roma
Default action for error routine to perform.
ACTION_EMS - Static variable in interface com.candle.roma.kxc.Roma
Error analysis routine should do a put to the exception message service.
ACTION_EMSRAW - Static variable in interface com.candle.roma.kxc.Roma
Error analysis routine should send a raw message to the exception message service.
ACTION_LOG - Static variable in interface com.candle.roma.kxc.Roma
Error analysis routine should do a write to the log.
ACTION_NOACTION - Static variable in interface com.candle.roma.kxc.Roma
Error analysis routine should take no action at all.
ACTION_NOTIFY - Static variable in interface com.candle.roma.kxc.Roma
Error analysis routine should send a notification message.
ACTION_RESET - Static variable in interface com.candle.roma.kxc.Roma
Error analysis routine should do a reset of the error and carry on.
action(RomaDirectoryItem) - Method in class com.candle.roma.kxc.RomaDirectoryAgent
Invoked for each item in the current selection when processAll is called.
addAttribute(String, String) - Method in class com.candle.roma.kxc.RomaDirectoryItem
Add attribute to item.
additionalInfo(int) - Method in class com.candle.roma.kxc.RomaError
Returns the additional information if an error has occurred.
ADVISORY - Static variable in interface com.candle.roma.kxc.Roma
 
allowNative(boolean) - Method in class com.candle.roma.kxc.RomaGetOptions
Enables or disables the option to retrieve native (ie, non-Roma) messages.
ANY_THEME - Static variable in interface com.candle.roma.kxc.Roma
Get selector that specifies criteria for retrieving a message; in this case, get any message
anyError() - Method in class com.candle.roma.kxc.RomaError
Returns true if an error is set
APP_EXCLUSIVE - Static variable in interface com.candle.roma.kxc.Roma
Indicates that the application has to have sole access to the queue.
APP_MQSERIES_XACTION - Static variable in interface com.candle.roma.kxc.Roma
Indicates that Roma expects MQSeries to do the transaction control.
APP_NON_XACTIONAL - Static variable in interface com.candle.roma.kxc.Roma
Indicates that if the queue is on MSMQ and does not already exist, Roma should create the queue as a non-transactional queue.
APP_NONE - Static variable in interface com.candle.roma.kxc.Roma
No application options set.
APP_ROLLBK_OS_XACT - Static variable in interface com.candle.roma.kxc.Roma
Indicates that pending transactions must be rolled back on disconnection.
APPTYPE_BRIDGE - Static variable in interface com.candle.roma.kxc.Roma
 
APPTYPE_CLIENT - Static variable in interface com.candle.roma.kxc.Roma
 
APPTYPE_NATIVE_CLIENT - Static variable in interface com.candle.roma.kxc.Roma
 
APPTYPE_NATIVE_SERVER - Static variable in interface com.candle.roma.kxc.Roma
 
APPTYPE_SERVER - Static variable in interface com.candle.roma.kxc.Roma
 
APPTYPE_UNKNOWN - Static variable in interface com.candle.roma.kxc.Roma
 
attributeName() - Method in class com.candle.roma.kxc.RomaDirectoryItem
Returns name of the first attribute
attributeName(int) - Method in class com.candle.roma.kxc.RomaDirectoryItem
Returns name of nth attribute.
attributes() - Method in class com.candle.roma.kxc.RomaDirectoryItem
Returns the number of attributes
attributeValue() - Method in class com.candle.roma.kxc.RomaDirectoryItem
Returns value of the first attribute
attributeValue(int) - Method in class com.candle.roma.kxc.RomaDirectoryItem
Returns value of nth attribute.
attributeValue(String) - Method in class com.candle.roma.kxc.RomaDirectoryItem
Returns value of first occurrence of named attribute
attributeValue(String, int) - Method in class com.candle.roma.kxc.RomaDirectoryItem
Returns value of nth occurrence of named attribute

B

BACKOUT_UNSUPPORTED - Static variable in interface com.candle.roma.kxc.Roma
Backout count capabilities not supported.
backoutCount() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the backout count.
backoutCount() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the backout count.
backoutCount() - Method in class com.candle.roma.kxc.RomaStorable
Return the backout count.
BUF_HEADER_SIZE - Static variable in class com.candle.roma.kxc.RomaDirectoryItem
 
BUF_RES_SIZE - Static variable in class com.candle.roma.kxc.RomaDirectoryItem
 
buildTheme(RomaTheme, RomaThemeInfo, int, boolean) - Method in class com.candle.roma.kxc.RomaClient
Creates a new theme from the source theme and the specified theme information.
buildTheme(RomaTheme, RomaThemeInfo, int, boolean) - Method in class com.candle.roma.kxc.RomaBusinessElement
Creates a new theme from the source theme and the theme details.
BY_CORRELID - Static variable in interface com.candle.roma.kxc.Roma
Get selector that specifies criteria for retrieving a message; in this case, get message by correlation id.
BY_MSGID - Static variable in interface com.candle.roma.kxc.Roma
Get selector that specifies criteria for retrieving a message; in this case, get message with matched message identifier.
BY_MSGID_AND_CORRELID - Static variable in interface com.candle.roma.kxc.Roma
Get selector that specifies criteria for retrieving a message; in this case, get message using combination of BY_MSGID and BY_CORRELID.
BY_MSGID_AND_THEME - Static variable in interface com.candle.roma.kxc.Roma
Get selector that specifies criteria for retrieving a message; in this case, get message using a combination of BY_MSGID and BY_THEME.
BY_NONE - Static variable in interface com.candle.roma.kxc.Roma
Get selector that specifies criteria for retrieving a message; in this case, get any message.
BY_THEME - Static variable in interface com.candle.roma.kxc.Roma
Get selector specifies criteria for retrieving a message; in this case, get message with matched theme.

C

CALLTYPE_APPLICATION - Static variable in interface com.candle.roma.kxc.Roma
Application call type.
CALLTYPE_BRIDGEGET - Static variable in interface com.candle.roma.kxc.Roma
get from bridge call type.
CALLTYPE_BRIDGEPUT - Static variable in interface com.candle.roma.kxc.Roma
Put to bridge call type.
CALLTYPE_BUILDTHEME - Static variable in interface com.candle.roma.kxc.Roma
Theme build call type.
CALLTYPE_CLOSEHANDLE - Static variable in interface com.candle.roma.kxc.Roma
Close handle call type.
CALLTYPE_CLOSESTORAGEQ - Static variable in interface com.candle.roma.kxc.Roma
Close a storage queue call type.
CALLTYPE_COMMIT - Static variable in interface com.candle.roma.kxc.Roma
Commit call type.
CALLTYPE_DELETESTORAGEQ - Static variable in interface com.candle.roma.kxc.Roma
Delete a storage queue call type.
CALLTYPE_DIRDELETEITEM - Static variable in interface com.candle.roma.kxc.Roma
Delete directory item call type.
CALLTYPE_DIRGETDN - Static variable in interface com.candle.roma.kxc.Roma
Get directory item distinguished name call type.
CALLTYPE_DIRGETMODCOUNT - Static variable in interface com.candle.roma.kxc.Roma
Get directory modification count call type.
CALLTYPE_DIRLOOKUP - Static variable in interface com.candle.roma.kxc.Roma
Directory look up call type.
CALLTYPE_DIRUPDATEITEM - Static variable in interface com.candle.roma.kxc.Roma
Update directory item call type.
CALLTYPE_FREEBUFFER - Static variable in interface com.candle.roma.kxc.Roma
Free buffer call type.
CALLTYPE_GETFROMSTORAGEQ - Static variable in interface com.candle.roma.kxc.Roma
Get from a storage queue call type.
CALLTYPE_GETILSDATA - Static variable in interface com.candle.roma.kxc.Roma
Get ILS data call type.
CALLTYPE_GETREQUEST - Static variable in interface com.candle.roma.kxc.Roma
Get request call type.
CALLTYPE_GETRESPONSE - Static variable in interface com.candle.roma.kxc.Roma
Get response call type.
CALLTYPE_INITIALIZE - Static variable in interface com.candle.roma.kxc.Roma
Initialize call type.
CALLTYPE_INTERPRETMSG - Static variable in interface com.candle.roma.kxc.Roma
Interpret message call type.
CALLTYPE_OPENSTORAGEQ - Static variable in interface com.candle.roma.kxc.Roma
Open a storage queue call type.
CALLTYPE_PURGEQTOEMS - Static variable in interface com.candle.roma.kxc.Roma
Purge queue to EMS call type.
CALLTYPE_PUTEXCEPTION - Static variable in interface com.candle.roma.kxc.Roma
Put exception message call type.
CALLTYPE_PUTREQUEST - Static variable in interface com.candle.roma.kxc.Roma
Put request call type.
CALLTYPE_PUTRESPONSE - Static variable in interface com.candle.roma.kxc.Roma
Put response call type.
CALLTYPE_PUTTOSTORAGEQ - Static variable in interface com.candle.roma.kxc.Roma
Put to a storage queue call type.
CALLTYPE_QUERYCONTEXT - Static variable in interface com.candle.roma.kxc.Roma
Context query call type.
CALLTYPE_QUERYTHEME - Static variable in interface com.candle.roma.kxc.Roma
Theme query call type.
CALLTYPE_REPORTERROR - Static variable in interface com.candle.roma.kxc.Roma
Report error call type.
CALLTYPE_ROLLBACK - Static variable in interface com.candle.roma.kxc.Roma
Rollback call type.
CALLTYPE_SENDALERT - Static variable in interface com.candle.roma.kxc.Roma
Send alert call type.
CALLTYPE_SETILSDATA - Static variable in interface com.candle.roma.kxc.Roma
Set ILS data call type.
CALLTYPE_SETLDAPSERVICE - Static variable in interface com.candle.roma.kxc.Roma
set up LDAP service call type.
CALLTYPE_TERMINATE - Static variable in interface com.candle.roma.kxc.Roma
Terminate call type.
CALLTYPE_WRITELOG - Static variable in interface com.candle.roma.kxc.Roma
Write to log call type.
CALLTYPE_XPORTDATA - Static variable in interface com.candle.roma.kxc.Roma
Export data call type.
CC_FAILED - Static variable in interface com.candle.roma.kxc.Roma
 
CC_OK - Static variable in interface com.candle.roma.kxc.Roma
 
CC_WARNING - Static variable in interface com.candle.roma.kxc.Roma
 
clone() - Method in class com.candle.roma.kxc.RomaTrailer
Returns a copy of the object.
clone() - Method in class com.candle.roma.kxc.RomaThemeInfo
Returns a copy of the object.
clone() - Method in class com.candle.roma.kxc.RomaWorkflowService
Returns a copy of the object.
clone() - Method in class com.candle.roma.kxc.RomaRoute
Returns a copy of the object.
clone() - Method in class com.candle.roma.kxc.RomaWorkflow
Returns a copy of the object.
clone() - Method in class com.candle.roma.kxc.RomaBusinessFlow
Returns a copy of the object.
close() - Method in class com.candle.roma.kxc.RomaStorageQueue
Close the storage queue.
closeTheme(RomaTheme) - Method in class com.candle.roma.kxc.RomaContext
Closes a Roma theme.
CODEPAGE_PROFILE - Static variable in interface com.candle.roma.kxc.Roma
Retrieve message codepage value from a Put API profile.
CODEPAGE_USER - Static variable in interface com.candle.roma.kxc.Roma
Message codepage value.
codepage() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the message codepage.
codepage() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the message codepage.
codepage() - Method in class com.candle.roma.kxc.RomaStorable
Return the message codepage.
com.candle.roma.kxc - package com.candle.roma.kxc
 
commitLocal() - Method in class com.candle.roma.kxc.RomaContext
Commits any local Roma transactions outstanding on current thread.
compCode(int) - Method in class com.candle.roma.kxc.RomaError
Returns either the completion code of the error or else the code Roma.CC_OK if no error information is available.
CONFIRM_ARRIVAL - Static variable in interface com.candle.roma.kxc.Roma
 
CONFIRM_DELIVERY - Static variable in interface com.candle.roma.kxc.Roma
 
connect(String) - Method in class com.candle.roma.kxc.RomaClient
Attaches a named Client to the Roma network.
connect(String) - Method in class com.candle.roma.kxc.RomaBusinessElement
Attaches a named BusinessElement to the Roma network.
connect(String, int) - Method in class com.candle.roma.kxc.RomaClient
Attach to the Roma network.
connect(String, int) - Method in class com.candle.roma.kxc.RomaBusinessElement
Attaches a named BusinessElement to the Roma network.
connect(String, int, RomaSecurityDef) - Method in class com.candle.roma.kxc.RomaClient
Attach to the Roma network.
connect(String, int, RomaSecurityDef) - Method in class com.candle.roma.kxc.RomaBusinessElement
Attaches a named BusinessElement to the Roma network.
connect(String, int, RomaSecurityDef, String) - Method in class com.candle.roma.kxc.RomaClient
Attach to the Roma network.
connect(String, int, RomaSecurityDef, String) - Method in class com.candle.roma.kxc.RomaBusinessElement
Attaches a named BusinessElement to the Roma network.
copyTheme(RomaTheme) - Method in class com.candle.roma.kxc.RomaContext
Creates a new theme ID with exactly the same information as the existing theme.
correlId() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the message correlation identifier.
correlId() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the message correlation identifier.
correlId() - Method in class com.candle.roma.kxc.RomaBeResponse
Return the message correlation identifier.
correlId() - Method in class com.candle.roma.kxc.RomaStorable
Return the message correlation identifier.
correlId() - Method in class com.candle.roma.kxc.RomaClientRequest
Return the message correlation identifier.
correlId() - Method in class com.candle.roma.kxc.RomaExceptionMessage
Return the message correlation identifier.
createRequest(RomaBeRequest) - Method in class com.candle.roma.kxc.RomaBusinessElement
Unmarshal a retrieved request.
createResponse(RomaClientResponse) - Method in class com.candle.roma.kxc.RomaClient
Invoked in get() methods once the response has been retrieved from the Roma network.
createStorable(RomaStorable) - Method in class com.candle.roma.kxc.RomaStorageQueue
Invoked when a message is successfully retrieved from the storage queue, this method unmarshalls the recovered message.

D

DATAGRAM - Static variable in interface com.candle.roma.kxc.Roma
Message type.
deleteItem(String, String, String) - Method in class com.candle.roma.kxc.RomaDirectoryAgent
Delete the item with given distiguished name.
deleteStorageQueue(String) - Method in class com.candle.roma.kxc.RomaContext
Deletes storage queue.
disconnect() - Method in class com.candle.roma.kxc.RomaContext
Terminates the connection to Roma (if connected).
dn() - Method in class com.candle.roma.kxc.RomaDirectoryItem
Retrieves the distinguished name

E

ELEMENT_ALL_GET - Static variable in interface com.candle.roma.kxc.Roma
Indicator of which information is included as part of the exception message; in this case all of the information of a put operation plus the workflow details if available.
ELEMENT_ALL_PUT - Static variable in interface com.candle.roma.kxc.Roma
Indicator of what information is included as part of the exception message; in this case all information will be passed.
ELEMENT_CONFIG - Static variable in interface com.candle.roma.kxc.Roma
Indicator of what information is included as part of the exception message; in this case Roma provides details of its own configuration.
ELEMENT_ERROR - Static variable in interface com.candle.roma.kxc.Roma
Indicator of what information is included as part of the exception message; in this case error information is provided.
ELEMENT_MESSAGE - Static variable in interface com.candle.roma.kxc.Roma
Indicator of what information is included as part of the exception message; in this case the base message contains meaningful information.
ELEMENT_NONE - Static variable in interface com.candle.roma.kxc.Roma
Indicator of what information is included as part of the exception message; in this case no information provided.
ELEMENT_SYSCONFIG - Static variable in interface com.candle.roma.kxc.Roma
Indicator of what information is included as part of the exception message; in this case Roma provides details of the system configuration.
ELEMENT_TIMESTAMP - Static variable in interface com.candle.roma.kxc.Roma
Indicator of what information is included as part of the exception message; in this case Roma provides the timestamp.
ELEMENT_USERDATA - Static variable in interface com.candle.roma.kxc.Roma
Indicator of what information is included as part of the exception message; in this case user data is provided.
ELEMENT_WORKFLOW - Static variable in interface com.candle.roma.kxc.Roma
Indicator of what information is included as part of the exception message; in this case the workflow details.
ENCODING_DEFAULT - Static variable in interface com.candle.roma.kxc.Roma
Default message encoding used.
ENCODING_NORMAL - Static variable in interface com.candle.roma.kxc.Roma
Normal message encoding used.
ENCODING_PROFILE - Static variable in interface com.candle.roma.kxc.Roma
Retrieve message encoding value from a Put API profile.
ENCODING_REVERSED - Static variable in interface com.candle.roma.kxc.Roma
Reversed message encoding used.
encoding() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the encoding.
encoding() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the encoding.
encoding() - Method in class com.candle.roma.kxc.RomaStorable
Get the message encoding.
ENVOS_AIX - Static variable in interface com.candle.roma.kxc.Roma
 
ENVOS_DUX - Static variable in interface com.candle.roma.kxc.Roma
 
ENVOS_HPUX102 - Static variable in interface com.candle.roma.kxc.Roma
 
ENVOS_HPUX11 - Static variable in interface com.candle.roma.kxc.Roma
 
ENVOS_MVSBATCH - Static variable in interface com.candle.roma.kxc.Roma
 
ENVOS_MVSCICS - Static variable in interface com.candle.roma.kxc.Roma
 
ENVOS_OS400 - Static variable in interface com.candle.roma.kxc.Roma
 
ENVOS_SUN - Static variable in interface com.candle.roma.kxc.Roma
 
ENVOS_WIN95 - Static variable in interface com.candle.roma.kxc.Roma
 
ENVOS_WINNT - Static variable in interface com.candle.roma.kxc.Roma
 
ENVTYPE_INTEL - Static variable in interface com.candle.roma.kxc.Roma
 
ENVTYPE_MVS - Static variable in interface com.candle.roma.kxc.Roma
 
ENVTYPE_OS400 - Static variable in interface com.candle.roma.kxc.Roma
 
ENVTYPE_UNIX - Static variable in interface com.candle.roma.kxc.Roma
 
ENVTYPE_VMS - Static variable in interface com.candle.roma.kxc.Roma
 
equals(Object) - Method in class com.candle.roma.kxc.RomaTheme
Object equality test.
ERROR_STATUS_BOTH - Static variable in interface com.candle.roma.kxc.Roma
Information on both main and sub errors are available.
ERROR_STATUS_MAIN - Static variable in interface com.candle.roma.kxc.Roma
Information on a main type of error is available.
ERROR_STATUS_NONE - Static variable in interface com.candle.roma.kxc.Roma
No Roma error has occurred.
ERROR_TEXT_COMPACT - Static variable in interface com.candle.roma.kxc.Roma
 
ERROR_TEXT_FULL - Static variable in interface com.candle.roma.kxc.Roma
 
errorText(int, int) - Method in class com.candle.roma.kxc.RomaError
Returns the error string if an error has occurred.
errorType(int) - Method in class com.candle.roma.kxc.RomaError
Returns either the error type code of the error or else 0 if no error information is available.
ETYPE_API - Static variable in interface com.candle.roma.kxc.Roma
 
ETYPE_CRITICAL - Static variable in interface com.candle.roma.kxc.Roma
 
ETYPE_ERROR - Static variable in interface com.candle.roma.kxc.Roma
 
ETYPE_TRANSIENT - Static variable in interface com.candle.roma.kxc.Roma
 
EXACTMATCH - Static variable in interface com.candle.roma.kxc.Roma
Search type.
EXPIRY_NEVER - Static variable in interface com.candle.roma.kxc.Roma
Message never expires.
EXPIRY_PROFILE - Static variable in interface com.candle.roma.kxc.Roma
Retrieve message expiry interval from Put API profile.
expiry() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the message expiry time in seconds.
expiry() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the message expiry time in seconds.
expiry() - Method in class com.candle.roma.kxc.RomaStorable
Return the message expiry time in seconds.

F

feedback() - Method in class com.candle.roma.kxc.RomaBeRequest
Get the message feedback code.
feedback() - Method in class com.candle.roma.kxc.RomaClientResponse
Get the message feedback code.
feedback() - Method in class com.candle.roma.kxc.RomaStorable
Get the message feedback code.
FORCE - Static variable in interface com.candle.roma.kxc.Roma
Store option.
FORMAT_BINARY - Static variable in interface com.candle.roma.kxc.Roma
Binary message format identifier.
FORMAT_BINARY_ENC - Static variable in interface com.candle.roma.kxc.Roma
Encrypted binary message format identifier.
FORMAT_BINARY_SIGN - Static variable in interface com.candle.roma.kxc.Roma
Signed binary message format identifier.
FORMAT_BINARY_SIGN_ENC - Static variable in interface com.candle.roma.kxc.Roma
Signed, encrypted binary message format identifier.
FORMAT_HEXDUMP - Static variable in interface com.candle.roma.kxc.Roma
Indication of the type of Roma-supplied formatting to use; in this case do a hex dump of the user data.
FORMAT_NONE - Static variable in interface com.candle.roma.kxc.Roma
Indication of the type of Roma-supplied formatting to use; in this case, none.
FORMAT_NOSEVERITY - Static variable in interface com.candle.roma.kxc.Roma
Indication of the type of Roma-supplied formatting to use; in this case do not print a severity.
FORMAT_NOTIMESTAMP - Static variable in interface com.candle.roma.kxc.Roma
Indication of the type of Roma-supplied formatting to use; in this case do not print a timestamp.
FORMAT_PROFILE - Static variable in interface com.candle.roma.kxc.Roma
Retrieve message format from Put API profile.
FORMAT_STRING - Static variable in interface com.candle.roma.kxc.Roma
String message format identifier.
FORMAT_STRING_ENC - Static variable in interface com.candle.roma.kxc.Roma
Encrypted character string message format identifier.
FORMAT_STRING_SIGN - Static variable in interface com.candle.roma.kxc.Roma
Signed character string message format identifier.
FORMAT_STRING_SIGN_ENC - Static variable in interface com.candle.roma.kxc.Roma
Signed, encrypted character string message format identifier.
FORMAT_USENAME - Static variable in interface com.candle.roma.kxc.Roma
Message format identified by a text name picked up from the formatName field.
FORMAT_USER - Static variable in interface com.candle.roma.kxc.Roma
User defined message format.
format() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the message format.
format() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the message format.
format() - Method in class com.candle.roma.kxc.RomaStorable
Return the message format.
formatName() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the message format name.
formatName() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the message format name.
formatName() - Method in class com.candle.roma.kxc.RomaStorable
Return the message format name.

G

GET_FIRST - Static variable in interface com.candle.roma.kxc.Roma
Get the first message.
GET_PEEKED - Static variable in interface com.candle.roma.kxc.Roma
Get the message under the current read position.
get() - Method in class com.candle.roma.kxc.RomaClient
Gets the response to an earlier Client using default options.
get() - Method in class com.candle.roma.kxc.RomaBusinessElement
Gets a client request using default get options, i.e.
get(RomaGetOptions) - Method in class com.candle.roma.kxc.RomaClient
Gets the response to an earlier Client request using supplied options.
get(RomaGetOptions) - Method in class com.candle.roma.kxc.RomaBusinessElement
Gets a client request according to the supplied get options.
get(RomaGetOptions, byte[], RomaInteger) - Method in class com.candle.roma.kxc.RomaBusinessElement
Gets a client request according to the supplied get options.
get(RomaGetOptions, byte[], RomaInteger, byte[], RomaInteger) - Method in class com.candle.roma.kxc.RomaClient
Gets the response to an earlier Client request request using supplied options.
get(RomaGetOptions, byte[], RomaInteger, byte[], RomaInteger) - Method in class com.candle.roma.kxc.RomaBusinessElement
Gets a client request according to the supplied get options.
getAudit() - Method in class com.candle.roma.kxc.RomaWorkflowService
Returns the name of the audit object associated with the business service received the message.
getBeRequest() - Method in class com.candle.roma.kxc.RomaMessageInfo
Returns the message data as Business Element request.
getBuffer(int) - Method in class com.candle.roma.kxc.RomaILSData
Get specified in-line service buffer using the default type.
getBuffer(int, int) - Method in class com.candle.roma.kxc.RomaILSData
Get specified in-line service buffer
getCallType() - Method in class com.candle.roma.kxc.RomaExcErrorData
Returns the type of the failed procedure.
getClientResponse() - Method in class com.candle.roma.kxc.RomaMessageInfo
Returns the message data as Client response.
getComponent() - Method in class com.candle.roma.kxc.RomaWorkflowService
Returns the name of the business component received the message.
getComponentName() - Method in class com.candle.roma.kxc.RomaConfig
Returns the name of the business component reporting the error.
getConfirmFlags() - Method in class com.candle.roma.kxc.RomaThemeInfo
Returns the confirmation flags.
getData() - Method in class com.candle.roma.kxc.RomaTrailer
Returns the application-defined data of the trailer.
getDomainName() - Method in class com.candle.roma.kxc.RomaSystemConfig
Returns the domain name.
getElementName() - Method in class com.candle.roma.kxc.RomaConfig
Returns the name of the application (client, server, or bridge) that sent the message to the exception message handler.
getElementType() - Method in class com.candle.roma.kxc.RomaConfig
Returns the type of application that sent the message to the exception message handler.
getEnvOS() - Method in class com.candle.roma.kxc.RomaSystemConfig
Returns the OS type of the environment on which the reporting application is running.
getEnvType() - Method in class com.candle.roma.kxc.RomaSystemConfig
Returns the architecture type of the environment on which the reporting application is running.
getError() - Method in class com.candle.roma.kxc.RomaExcErrorData
Returns the error information set by the reporting application.
getErrorData() - Method in class com.candle.roma.kxc.RomaExceptionInfo
Returns the error data set by the reporting application.
getEteInfo() - Method in class com.candle.roma.kxc.RomaThemeInfo
Returns the end-to-end and in-flight information.
getException() - Method in class com.candle.roma.kxc.RomaMessageInfo
Returns the exception details.
getFlags() - Method in class com.candle.roma.kxc.RomaRoute
Returns the route flags.
getFlowName() - Method in class com.candle.roma.kxc.RomaBusinessFlow
Returns the business flow name.
getILSData() - Method in class com.candle.roma.kxc.RomaBeRequest
Get incoming ILS data
getILSData() - Method in class com.candle.roma.kxc.RomaClientResponse
Get incoming ILS data
getILSData() - Method in class com.candle.roma.kxc.RomaBeResponse
Get incoming ILS data
getILSData() - Method in class com.candle.roma.kxc.RomaClientRequest
Get incoming ILS data
getMethod() - Method in class com.candle.roma.kxc.RomaTrailer
Returns the number of the ILS that has added this persistent trailer.
getName() - Method in class com.candle.roma.kxc.RomaBusinessService
Returns the service name.
getNextBuffer(RomaInteger, RomaInteger) - Method in class com.candle.roma.kxc.RomaILSData
Get next in-line service buffer
getNodeName() - Method in class com.candle.roma.kxc.RomaConfig
Returns the name of the node on which the error occurred.
getOperationName() - Method in class com.candle.roma.kxc.RomaBusinessFlow
Returns the operation name.
getProcessId() - Method in class com.candle.roma.kxc.RomaSystemConfig
Returns the process ID assigned to the reporting application.
getProgramName() - Method in class com.candle.roma.kxc.RomaSystemConfig
Returns the name of the application reporting the error.
getQueueName() - Method in class com.candle.roma.kxc.RomaExcErrorData
Returns the name of the queue on which the failed operation was operating.
getQueueName() - Method in class com.candle.roma.kxc.RomaConfig
Returns the name of the application’s input (that is, response or request) queue.
getRetryCount() - Method in class com.candle.roma.kxc.RomaThemeInfo
Returns the retry count.
getRomaConfig() - Method in class com.candle.roma.kxc.RomaExceptionInfo
Returns the Roma configuration of the reporting application.
getRoutes() - Method in class com.candle.roma.kxc.RomaWorkflow
Returns the route steps of the workflow.
getService() - Method in class com.candle.roma.kxc.RomaWorkflowService
Returns the name of the business service received the message.
getServiceName() - Method in class com.candle.roma.kxc.RomaConfig
Returns the name of the business service of which this application is a member.
getSourceFlow() - Method in class com.candle.roma.kxc.RomaWorkflowService
Returns the name of the business flow that has updated the workflow.
getSourceFlow() - Method in class com.candle.roma.kxc.RomaRoute
Returns the name of the business flow that has updated the route step.
getSourceOperation() - Method in class com.candle.roma.kxc.RomaWorkflowService
Returns the name of the operation that has updated the workflow.
getSourceOperation() - Method in class com.candle.roma.kxc.RomaRoute
Returns the name of the operation that has updated the route step.
getSourceService() - Method in class com.candle.roma.kxc.RomaWorkflowService
Returns the name of the business service that has created or updated the workflow.
getSourceService() - Method in class com.candle.roma.kxc.RomaRoute
Returns the name of the business service that has created or updated the route step.
getSystemConfig() - Method in class com.candle.roma.kxc.RomaExceptionInfo
Returns the configuration of the system where the reporting application has been running.
getTargetCodePage() - Method in class com.candle.roma.kxc.RomaRoute
Returns the target code page.
getTargetComponent() - Method in class com.candle.roma.kxc.RomaRoute
Returns the target business component name.
getTargetElement() - Method in class com.candle.roma.kxc.RomaRoute
Returns the target business element name.
getTargetQueue() - Method in class com.candle.roma.kxc.RomaRoute
Returns the target queue name.
getTheme() - Method in class com.candle.roma.kxc.RomaMessageInfo
Returns the theme.
getThemeId() - Method in class com.candle.roma.kxc.RomaThemeInfo
Returns the theme ID.
getThreadId() - Method in class com.candle.roma.kxc.RomaSystemConfig
Returns the thread ID assigned to the reporting thread’s active thread.
getTimestamp() - Method in class com.candle.roma.kxc.RomaExceptionInfo
Returns the timestamp.
getTrailers() - Method in class com.candle.roma.kxc.RomaThemeInfo
Returns the persistent trailers.
getType() - Method in class com.candle.roma.kxc.RomaTrailer
Returns the type of the ILS that has added this persistent trailer.
getType() - Method in class com.candle.roma.kxc.RomaRoute
Returns the route type.
getUserData() - Method in class com.candle.roma.kxc.RomaExceptionInfo
Returns the user data.
getUserId() - Method in class com.candle.roma.kxc.RomaSystemConfig
Returns the user ID under which the reporting application is executing.
getWorkflow() - Method in class com.candle.roma.kxc.RomaMessageInfo
Returns the associated workflow.
getWorkflow() - Method in class com.candle.roma.kxc.RomaThemeInfo
Returns the associated workflow.
getWorkflowService() - Method in class com.candle.roma.kxc.RomaWorkflow
Returns the associated workflow service.
GOWAIT_INDEFINITE - Static variable in interface com.candle.roma.kxc.Roma
 
GOWAIT_PROFILE - Static variable in interface com.candle.roma.kxc.Roma
 

H

hasErrorData() - Method in class com.candle.roma.kxc.RomaExceptionInfo
 
hasException() - Method in class com.candle.roma.kxc.RomaMessageInfo
 
hasMessage() - Method in class com.candle.roma.kxc.RomaMessageInfo
 
hasRomaConfig() - Method in class com.candle.roma.kxc.RomaExceptionInfo
 
hasSystemConfig() - Method in class com.candle.roma.kxc.RomaExceptionInfo
 
hasTheme() - Method in class com.candle.roma.kxc.RomaMessageInfo
 
hasTimestamp() - Method in class com.candle.roma.kxc.RomaExceptionInfo
 
hasUserData() - Method in class com.candle.roma.kxc.RomaExceptionInfo
 
hasWorkflow() - Method in class com.candle.roma.kxc.RomaMessageInfo
 

I

ILS_TYPE_ERROR - Static variable in interface com.candle.roma.kxc.Roma
 
ILS_TYPE_ROUTER - Static variable in interface com.candle.roma.kxc.Roma
 
ILS_TYPE_SYSMGMT - Static variable in interface com.candle.roma.kxc.Roma
 
ILS_TYPE_USER - Static variable in interface com.candle.roma.kxc.Roma
 
ILS_TYPE_WEB - Static variable in interface com.candle.roma.kxc.Roma
 
ILS_TYPE_XPORT - Static variable in interface com.candle.roma.kxc.Roma
 
ILS_TYPE_XPTDATA - Static variable in interface com.candle.roma.kxc.Roma
 
insertWorkflow(RomaTheme, RomaBusinessService, boolean) - Method in class com.candle.roma.kxc.RomaContext
Inserts the business service into the workflow of the theme immediately after the current location in the workflow.
interpretMessage(RomaBeRequest, int) - Method in class com.candle.roma.kxc.RomaBusinessElement
Returns detailed information on the specified message.
interpretMessage(RomaClientResponse, int) - Method in class com.candle.roma.kxc.RomaClient
Returns detailed information on the specified message.
INTMSG_THEME - Static variable in interface com.candle.roma.kxc.Roma
 
intValue() - Method in class com.candle.roma.kxc.RomaInteger
 
isConnected() - Method in class com.candle.roma.kxc.RomaContext
Returns true if connection established, false otherwise.
isNull() - Method in class com.candle.roma.kxc.RomaTheme
Returns true if this object represent a null theme.
isOpen() - Method in class com.candle.roma.kxc.RomaStorageQueue
Check whether the storage queue is open.
isTermIndicator() - Method in class com.candle.roma.kxc.RomaBusinessElement
 
item(int) - Method in class com.candle.roma.kxc.RomaDirectoryAgent
Retrieve nth item form the search.
item(int, RomaInteger) - Method in class com.candle.roma.kxc.RomaDirectoryAgent
Retrieve nth item form the search and flag whether the directory has been modified.

L

lookup(RomaBusinessElement, String, String, int) - Method in class com.candle.roma.kxc.RomaDirectoryAgent
set new parameters for directory search
lookup(RomaBusinessElement, String, String, int, int) - Method in class com.candle.roma.kxc.RomaDirectoryAgent
set new parameters for directory search
lookup(RomaClient, String, String, int) - Method in class com.candle.roma.kxc.RomaDirectoryAgent
set new parameters for directory search
lookup(RomaClient, String, String, int, int) - Method in class com.candle.roma.kxc.RomaDirectoryAgent
set new parameters for directory search

M

marshalForStorage() - Method in class com.candle.roma.kxc.RomaStorable
Called before the PUT operation this method may be overriden in a derived class for data marshalling.
marshalRequest() - Method in class com.candle.roma.kxc.RomaClientRequest
Invoked from the RomaClient.put() method immediately prior to attempting to issue the request to the Roma network.
marshalResponse() - Method in class com.candle.roma.kxc.RomaBeResponse
Marshalls response data immediately prior the reponse being sent.
matches() - Method in class com.candle.roma.kxc.RomaDirectoryAgent
Returns number of matching items.
matches(RomaInteger) - Method in class com.candle.roma.kxc.RomaDirectoryAgent
Returns number of matching items and modified flag.
MAX_LEN - Static variable in interface com.candle.roma.kxc.Roma
Maximum length of the message buffer.
MAX_TAGLEN - Static variable in interface com.candle.roma.kxc.Roma
Maximum length of the tag buffer.
mergeEteInfo(RomaTheme, RomaEteInfo, boolean) - Method in class com.candle.roma.kxc.RomaContext
Merges the end-to-end and in-flight information with the end-to-end and in-flight information that already exists for the message and can be extracted with the RomaBusinessElement.queryTheme(RomaTheme) or RomaClient.queryTheme(RomaTheme) method.
msgBuffer() - Method in class com.candle.roma.kxc.RomaBeRequest
Return message data buffer.
msgBuffer() - Method in class com.candle.roma.kxc.RomaClientResponse
Return reference to the message data buffer.
msgBuffer() - Method in class com.candle.roma.kxc.RomaStorable
Return reference to the message data buffer.
msgDataLength() - Method in class com.candle.roma.kxc.RomaBeRequest
Return message data buffer length.
msgDataLength() - Method in class com.candle.roma.kxc.RomaClientResponse
Return message data buffer length.
msgDataLength() - Method in class com.candle.roma.kxc.RomaStorable
Return length of data in the message buffer.
msgId() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the message identifier in a byte array.
msgId() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the message identifier in a byte array.
msgId() - Method in class com.candle.roma.kxc.RomaBeResponse
Return the message identifier in a byte array.
msgId() - Method in class com.candle.roma.kxc.RomaStorable
Return the message identifier in a byte array.
msgId() - Method in class com.candle.roma.kxc.RomaClientRequest
Return the message identifier in a byte array.
msgId() - Method in class com.candle.roma.kxc.RomaExceptionMessage
Return the message identifier in a byte array.
msgName() - Method in class com.candle.roma.kxc.RomaBeRequest
Returns name of message
msgName() - Method in class com.candle.roma.kxc.RomaClientResponse
Returns name of message
msgType() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the message type.
msgType() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the message type.
MUST_EXIST - Static variable in interface com.candle.roma.kxc.Roma
Store option.
MUST_NOT_EXIST - Static variable in interface com.candle.roma.kxc.Roma
Store option.

N

NEGATIVE_COA - Static variable in interface com.candle.roma.kxc.Roma
 
NEGATIVE_COD - Static variable in interface com.candle.roma.kxc.Roma
 
NEGATIVE_PUBSUB - Static variable in interface com.candle.roma.kxc.Roma
 
NOTIFICATION - Static variable in interface com.candle.roma.kxc.Roma
Message type.

O

ONELEVEL - Static variable in interface com.candle.roma.kxc.Roma
Search type.
OP_CICS - Static variable in interface com.candle.roma.kxc.Roma
 
OP_KXC - Static variable in interface com.candle.roma.kxc.Roma
 
OP_LDAP - Static variable in interface com.candle.roma.kxc.Roma
 
OP_LDIF - Static variable in interface com.candle.roma.kxc.Roma
 
OP_LIB - Static variable in interface com.candle.roma.kxc.Roma
 
OP_MQSERIES - Static variable in interface com.candle.roma.kxc.Roma
 
OP_MSMQ - Static variable in interface com.candle.roma.kxc.Roma
 
OP_OS - Static variable in interface com.candle.roma.kxc.Roma
 
OP_RPC - Static variable in interface com.candle.roma.kxc.Roma
 
OP_USER - Static variable in interface com.candle.roma.kxc.Roma
 
OPEN_DEFAULT - Static variable in interface com.candle.roma.kxc.Roma
Queue open option that enables both that both store() and retrieve() actions to be permitted and that non-destructive operations also be allowed.
OPEN_DELETE_ON_CLOSE - Static variable in interface com.candle.roma.kxc.Roma
Queue open option.
OPEN_EXCLUSIVE - Static variable in interface com.candle.roma.kxc.Roma
Queue open option.
OPEN_INPUT - Static variable in interface com.candle.roma.kxc.Roma
Queue open option that enables retrieve() to be used.
OPEN_MUST_EXIST - Static variable in interface com.candle.roma.kxc.Roma
Queue open option.
OPEN_NON_XACTIONAL - Static variable in interface com.candle.roma.kxc.Roma
Queue open option.
OPEN_OUTPUT - Static variable in interface com.candle.roma.kxc.Roma
Queue open option that enables store() to be used.
OPEN_PEEK - Static variable in interface com.candle.roma.kxc.Roma
Queue open option that permits non-destructive actions.
open(RomaBusinessElement, String) - Method in class com.candle.roma.kxc.RomaStorageQueue
Open the named storage queue using a given business element.
open(RomaBusinessElement, String, int) - Method in class com.candle.roma.kxc.RomaStorageQueue
Open the named storage queue using a given business element.
open(RomaBusinessElement, String, int, String) - Method in class com.candle.roma.kxc.RomaStorageQueue
Open the named storage queue using a given business element.
open(RomaClient, String) - Method in class com.candle.roma.kxc.RomaStorageQueue
Open the named storage queue using a given client.
open(RomaClient, String, int) - Method in class com.candle.roma.kxc.RomaStorageQueue
Open the named storage queue using a given client.
open(RomaClient, String, int, String) - Method in class com.candle.roma.kxc.RomaStorageQueue
Open the named storage queue using a given client.
operationType(int) - Method in class com.candle.roma.kxc.RomaError
If an error occurred, returns the operation type of the API call.

P

PEEK_FIRST - Static variable in interface com.candle.roma.kxc.Roma
Peek the first message.
PEEK_NEXT - Static variable in interface com.candle.roma.kxc.Roma
Peek the next message.
PEEK_SAME - Static variable in interface com.candle.roma.kxc.Roma
Peek the message under the current read position.
PERSISTENCE_NO - Static variable in interface com.candle.roma.kxc.Roma
Persistence disabled flag.
PERSISTENCE_PROFILE - Static variable in interface com.candle.roma.kxc.Roma
Default persistence is to be used.
PERSISTENCE_YES - Static variable in interface com.candle.roma.kxc.Roma
Perisitence enabled flag
persistence() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the persistence.
persistence() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the persistence.
persistence() - Method in class com.candle.roma.kxc.RomaStorable
return the message perisitence value.
position(int) - Method in class com.candle.roma.kxc.RomaError
Returns the position if an error has occurred.
POSITIVE_COA - Static variable in interface com.candle.roma.kxc.Roma
 
POSITIVE_COD - Static variable in interface com.candle.roma.kxc.Roma
 
POSITIVE_PUBSUB - Static variable in interface com.candle.roma.kxc.Roma
 
PRIMARY_INFO - Static variable in interface com.candle.roma.kxc.Roma
 
PRIORITY_DEFAULT - Static variable in interface com.candle.roma.kxc.Roma
Default message priority is to be used.
PRIORITY_PROFILE - Static variable in interface com.candle.roma.kxc.Roma
Default message priority as specified by the API profile is to be used.
priority() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the message priority.
priority() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the message priority.
priority() - Method in class com.candle.roma.kxc.RomaStorable
Returns the priority assigned to the message.
processAll() - Method in class com.candle.roma.kxc.RomaDirectoryAgent
Process each item in the current selection.
PUBLICATION - Static variable in interface com.candle.roma.kxc.Roma
 
publish(RomaClientRequest, RomaSubject) - Method in class com.candle.roma.kxc.RomaClient
Analagous to a put, but the request is treated as a publication on the specified subject.
put(RomaBeResponse) - Method in class com.candle.roma.kxc.RomaBusinessElement
Issues a response to a Client request.
put(RomaClientRequest) - Method in class com.candle.roma.kxc.RomaClient
Puts a request to a Business Service.
putException(RomaExceptionMessage) - Method in class com.candle.roma.kxc.RomaContext
Writes an exception message to the exception message queue with default RomaExceptionOptions.
putException(RomaExceptionMessage, RomaExceptionOptions) - Method in class com.candle.roma.kxc.RomaContext
Writes an exception message to the exception message queue.

Q

queryTheme(RomaTheme) - Method in class com.candle.roma.kxc.RomaClient
Returns information on the specified theme.
queryTheme(RomaTheme) - Method in class com.candle.roma.kxc.RomaBusinessElement
Returns information on the specified theme.

R

RC_ACCESS_DENIED - Static variable in interface com.candle.roma.kxc.Roma
 
RC_BACKED_OUT - Static variable in interface com.candle.roma.kxc.Roma
 
RC_BRIDGE_UNAVAILABLE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_BUFFER_ERROR - Static variable in interface com.candle.roma.kxc.Roma
 
RC_BUFFER_OVERFLOW - Static variable in interface com.candle.roma.kxc.Roma
 
RC_BUFFER_TOO_SMALL - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CACHE_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CALL_IN_PROGRESS - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_CALL_ABANDONED - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_COMMAND_TIMEOUT - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_COMMIT_ROLLBACK - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_CONN_QUIESCE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_EXEC_WAIT_ERROR - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_GETMAIN_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_GETSIG_FAIL - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_INVALID_POSTCODE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_KXCCCDIR_UNAVAILABLE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_KXCCTPI_UNAVAILABLE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_NO_TCTLS - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_QMGR_QUIESCE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_TRUE_INACTIVE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CICS_WAITFAIL - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CMQI_CALL_ABANDONED - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CONFIG_ERROR - Static variable in interface com.candle.roma.kxc.Roma
 
RC_CONTEXT_MISMATCH - Static variable in interface com.candle.roma.kxc.Roma
 
RC_DIRECTORY_UNAVAILABLE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_EXCEPTION_CAUGHT - Static variable in interface com.candle.roma.kxc.Roma
 
RC_EXIT_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_GET_ATTRIBUTE_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_HANDLE_BROKEN - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_APPDEF - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_COMPONENT - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_CONTEXT - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_ELEMENT - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_FILENAME - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_HANDLE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_MESSAGE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_MSGTYPE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_OPTIONS - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_PARAMETER - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_QNAME - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_RESPONSE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_ROUTE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_SECURITY - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_SERVERNAME - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_SERVICE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_SYNCTYPE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_THEME - Static variable in interface com.candle.roma.kxc.Roma
 
RC_INVALID_TRAILER - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_ADD_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_BIND_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_CONNECTION_LOST - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_COUNT_ENTRIES_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_DELETE_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_EXPORT_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_FIRST_ENTRY_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_GET_DN_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_GET_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_GET_VALUES_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_IMPORT_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_INVALID_GATEWAY - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_MODCOUNT_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_MODIFY_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_MODRDN_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_MSGFREE_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_NEXT_ENTRY_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_OPEN_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_SEARCH_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_UNBIND_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDAP_VALUE_FREE_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_ADD_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_CORRELID_NOT_SUPPORTED - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_COUNT_ENTRIES_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_DELETE_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_GET_DN_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_GET_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_GET_VALUES_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_INVALID_ATTR_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_INVALID_GATEWAY - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_INVALID_PS_OPTIONS - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_INVALID_SUBJECT - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_MODIFY_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_MSGID_NOT_SUPPORTED - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_NEXT_ENTRY_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_OPEN_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_PERSISTENCE_NOT_SUPPORTED - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_RENAME_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_SEARCH_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_LDIF_THREAD_INIT_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_MARSHALLING_ERROR - Static variable in interface com.candle.roma.kxc.Roma
 
RC_MESSAGE_SUPPRESSED - Static variable in interface com.candle.roma.kxc.Roma
 
RC_MSG_UNAVAILABLE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_MUTEX_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_NO_MSG_AVAILABLE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_NON_LOCALQ - Static variable in interface com.candle.roma.kxc.Roma
 
RC_NONXACTIONAL - Static variable in interface com.candle.roma.kxc.Roma
 
RC_NOT_ACCESSIBLE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_NOT_SUPPORTED - Static variable in interface com.candle.roma.kxc.Roma
 
RC_OK - Static variable in interface com.candle.roma.kxc.Roma
 
RC_Q_DELETED - Static variable in interface com.candle.roma.kxc.Roma
 
RC_Q_FULL - Static variable in interface com.candle.roma.kxc.Roma
 
RC_RESOURCE_PROBLEM - Static variable in interface com.candle.roma.kxc.Roma
 
RC_ROUTING_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_SIGNAL_ACCEPTED - Static variable in interface com.candle.roma.kxc.Roma
 
RC_SIGNAL_INVALID - Static variable in interface com.candle.roma.kxc.Roma
 
RC_SIGNAL_OUTSTANDING - Static variable in interface com.candle.roma.kxc.Roma
 
RC_STORAGE_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_SYSCONFIG_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_TRANSPORT_FAILURE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_TRANSPORT_UNAVAILABLE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_UNKNOWN_BRIDGE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_UNKNOWN_CLIENT - Static variable in interface com.candle.roma.kxc.Roma
 
RC_UNKNOWN_ERRPROFILE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_UNKNOWN_GETPROFILE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_UNKNOWN_MSGFORMAT - Static variable in interface com.candle.roma.kxc.Roma
 
RC_UNKNOWN_NODE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_UNKNOWN_OBJECT - Static variable in interface com.candle.roma.kxc.Roma
 
RC_UNKNOWN_PUTPROFILE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_UNKNOWN_SERVER - Static variable in interface com.candle.roma.kxc.Roma
 
RC_UNKNOWN_SERVICE - Static variable in interface com.candle.roma.kxc.Roma
 
RC_VALIDATION_FAILED - Static variable in interface com.candle.roma.kxc.Roma
 
RC_WAIT_CANCELLED - Static variable in interface com.candle.roma.kxc.Roma
 
reason(int) - Method in class com.candle.roma.kxc.RomaError
Returns either the reason code of the error or else 0 if no error information is available.
replaceWorkflow(RomaTheme, RomaBusinessService, boolean) - Method in class com.candle.roma.kxc.RomaContext
Replaces all remaining servers in the workflow with the business service, leaving the client at the end of the workflow.
reportError(RomaExceptionMessage, RomaInteger) - Method in class com.candle.roma.kxc.RomaContext
Invoke an error analysis routine directly with default RomaReportOptions.
reportError(RomaExceptionMessage, RomaInteger, RomaReportOptions) - Method in class com.candle.roma.kxc.RomaContext
Used to invoke an error analysis routine directly.
REQUEST - Static variable in interface com.candle.roma.kxc.Roma
Message type.
RESPONSE - Static variable in interface com.candle.roma.kxc.Roma
Message type.
retrieve() - Method in class com.candle.roma.kxc.RomaStorageQueue
Retrieves a message from the storage queue according to defaulted options.
retrieve(RomaRetrieveOptions) - Method in class com.candle.roma.kxc.RomaStorageQueue
Retrieves a message from the storage queue according to the supplied options.
retrieve(RomaRetrieveOptions, byte[], RomaInteger) - Method in class com.candle.roma.kxc.RomaStorageQueue
Retrieves a message from the storage queue according to the supplied options into user defined buffer.
returnCode(int) - Method in class com.candle.roma.kxc.RomaError
Returns the return code
rollbackLocal() - Method in class com.candle.roma.kxc.RomaContext
Rolls back any local Roma transactions outstanding on the current thread.
Roma - interface com.candle.roma.kxc.Roma.
This interface introduces various constants used by the other Roma classes in the package.
RomaBeRequest - class com.candle.roma.kxc.RomaBeRequest.
This class encapsulates requests received by Roma Business Elements.
RomaBeRequest() - Constructor for class com.candle.roma.kxc.RomaBeRequest
Constructs an empty request.
RomaBeRequest(RomaBeRequest) - Constructor for class com.candle.roma.kxc.RomaBeRequest
Constructs a new request object using an existing RomaBeRequest.
RomaBeResponse - class com.candle.roma.kxc.RomaBeResponse.
This class encapsulates responses made by a Roma Business Element following a Roma Client request.
RomaBeResponse(RomaBeRequest) - Constructor for class com.candle.roma.kxc.RomaBeResponse
Constructs a new RomaBeResponse object and initialises it with message id, correlation id and theme from supplied RomaBeRequest.
RomaBeResponse(RomaTheme) - Constructor for class com.candle.roma.kxc.RomaBeResponse
Constructs a new RomaBeResponse object and associates it with the specified theme
RomaBeResponse(RomaTheme, byte[], int) - Constructor for class com.candle.roma.kxc.RomaBeResponse
Constructs a new RomaBeResponse object, associates it with the specified theme and sets user message buffer.
RomaBeResponse(RomaTheme, byte[], int, byte[], int) - Constructor for class com.candle.roma.kxc.RomaBeResponse
Constructs a new RomaBeResponse object, associates it with the specified theme and sets user message buffer.
RomaBusinessElement - class com.candle.roma.kxc.RomaBusinessElement.
This class allows an application to instantiate a server-side connection to the Roma network as a Roma Business Element.
RomaBusinessElement() - Constructor for class com.candle.roma.kxc.RomaBusinessElement
Constructs a RomaBusinessElement object but does not attach the Business Element to the Roma network.
RomaBusinessElement(String) - Constructor for class com.candle.roma.kxc.RomaBusinessElement
Constructs and connects the new Business Element to the Roma network.
RomaBusinessElement(String, int) - Constructor for class com.candle.roma.kxc.RomaBusinessElement
Constructs and connects a Business Element to the Roma network.
RomaBusinessElement(String, int, RomaSecurityDef) - Constructor for class com.candle.roma.kxc.RomaBusinessElement
Constructs and connects a Business Element to the Roma network.
RomaBusinessElement(String, int, RomaSecurityDef, String) - Constructor for class com.candle.roma.kxc.RomaBusinessElement
Constructs and connects a Business Element to the Roma network.
RomaBusinessFlow - class com.candle.roma.kxc.RomaBusinessFlow.
This class defines the business flow information.
RomaBusinessFlow(String) - Constructor for class com.candle.roma.kxc.RomaBusinessFlow
Constructs the object with the specified data.
RomaBusinessFlow(String, String) - Constructor for class com.candle.roma.kxc.RomaBusinessFlow
Constructs the object with the specified data.
RomaBusinessService - class com.candle.roma.kxc.RomaBusinessService.
This class defines the Business Service information.
RomaBusinessService(String) - Constructor for class com.candle.roma.kxc.RomaBusinessService
Constructs the object with the specified data.
RomaClient - class com.candle.roma.kxc.RomaClient.
This class represents the application's client-side use of Roma.
RomaClient() - Constructor for class com.candle.roma.kxc.RomaClient
Constructs a new RomaClient object but does not attach to the Roma network.
RomaClient(String) - Constructor for class com.candle.roma.kxc.RomaClient
Constructs a named Client and attaches to the Roma network using default application options and with no security definition.
RomaClient(String, int) - Constructor for class com.candle.roma.kxc.RomaClient
Constructs a named Client, with the specified application options and security definition, and attaches to the Roma network.
RomaClient(String, int, RomaSecurityDef) - Constructor for class com.candle.roma.kxc.RomaClient
Constructs a named Client, with the specified application options and security definition, and attaches to the Roma network.
RomaClient(String, int, RomaSecurityDef, String) - Constructor for class com.candle.roma.kxc.RomaClient
Constructs a named Client, with the specified application options and security definition, and attaches to the Roma network.
RomaClientRequest - class com.candle.roma.kxc.RomaClientRequest.
This class encapsulates requests made by a Roma client to a Roma business service.
RomaClientRequest(String) - Constructor for class com.candle.roma.kxc.RomaClientRequest
Constructs request with default options and with the name of a Roma businesss service specified.
RomaClientRequest(String, byte[], int) - Constructor for class com.candle.roma.kxc.RomaClientRequest
Constructs request with default options, with the name of a Roma businesss service specified and user message buffer.
RomaClientRequest(String, byte[], int, byte[], int) - Constructor for class com.candle.roma.kxc.RomaClientRequest
Constructs request with default options, with the name of a Roma businesss service specified and user message buffer.
RomaClientResponse - class com.candle.roma.kxc.RomaClientResponse.
This class encapsulates responses returned to Roma client applications from a Roma Business Service.
RomaClientResponse() - Constructor for class com.candle.roma.kxc.RomaClientResponse
Constructs an empty response.
RomaClientResponse(RomaClientResponse) - Constructor for class com.candle.roma.kxc.RomaClientResponse
Constructs a new RomaClientResponse that is associated with the existing input RomaClientResponse object.
RomaConfig - class com.candle.roma.kxc.RomaConfig.
This class defines the Roma environment configuration of the application.
RomaContext - class com.candle.roma.kxc.RomaContext.
This is a base class that encapsulates the common options between a RomaClient and a RomaBusinessElement.
RomaContext() - Constructor for class com.candle.roma.kxc.RomaContext
 
RomaDirectoryAgent - class com.candle.roma.kxc.RomaDirectoryAgent.
This class encapsalates Roma directory access.
RomaDirectoryAgent(RomaBusinessElement, String, String, int) - Constructor for class com.candle.roma.kxc.RomaDirectoryAgent
Constructor for business element with no search options
RomaDirectoryAgent(RomaBusinessElement, String, String, int, int) - Constructor for class com.candle.roma.kxc.RomaDirectoryAgent
Constructor for business element with search options
RomaDirectoryAgent(RomaClient, String, String, int) - Constructor for class com.candle.roma.kxc.RomaDirectoryAgent
Constructor for client with no search options
RomaDirectoryAgent(RomaClient, String, String, int, int) - Constructor for class com.candle.roma.kxc.RomaDirectoryAgent
Constructor for client with search options
RomaDirectoryItem - class com.candle.roma.kxc.RomaDirectoryItem.
This class encapsalates a Roma directory item that has been retrieved from the Roma directory using the RomaDirectoryAgent class.
RomaDirectoryItem(String, String) - Constructor for class com.candle.roma.kxc.RomaDirectoryItem
Constructor All new items must have an objectclass attribute, so this is mandated in the constructor.
RomaError - exception com.candle.roma.kxc.RomaError.
This class introduces Roma errors.
RomaError() - Constructor for class com.candle.roma.kxc.RomaError
Constructs a new RomaError with no additional information.
RomaEteInfo - class com.candle.roma.kxc.RomaEteInfo.
This class defines the end-to-end and in-flight information of the message.
RomaExceptionInfo - class com.candle.roma.kxc.RomaExceptionInfo.
This class defines the message exception information.
RomaExceptionMessage - class com.candle.roma.kxc.RomaExceptionMessage.
This class is used to report erroneous messages to an Exception Messgage Queue by encapsulating the message that resulted in the error plus information about the error.
RomaExceptionMessage() - Constructor for class com.candle.roma.kxc.RomaExceptionMessage
Constructs a new exception message with no information.
RomaExceptionMessage(byte[], int) - Constructor for class com.candle.roma.kxc.RomaExceptionMessage
Constructs a new message exception object using an existing message buffer.
RomaExceptionMessage(RomaBeRequest) - Constructor for class com.candle.roma.kxc.RomaExceptionMessage
Constructs a new message exception object using an existing RomaBeRequest.
RomaExceptionMessage(RomaBeResponse) - Constructor for class com.candle.roma.kxc.RomaExceptionMessage
Constructs a new message exception object using an existing RomaBeResponse.
RomaExceptionMessage(RomaClientRequest) - Constructor for class com.candle.roma.kxc.RomaExceptionMessage
Constructs a new message exception object using an existing RomaClientRequest.
RomaExceptionMessage(RomaClientResponse) - Constructor for class com.candle.roma.kxc.RomaExceptionMessage
Constructs a new message exception object using an existing RomaClientResponse.
RomaExceptionMessage(RomaStorable) - Constructor for class com.candle.roma.kxc.RomaExceptionMessage
Constructs a new message exception object using an existing RomaStorable.
RomaExceptionOptions - class com.candle.roma.kxc.RomaExceptionOptions.
This class encapsulates the options when putting a RomaExceptionMessage on an Exception Message Queue.
RomaExceptionOptions() - Constructor for class com.candle.roma.kxc.RomaExceptionOptions
Constructs a new RomaExceptionOptions object with default options.
RomaExcErrorData - class com.candle.roma.kxc.RomaExcErrorData.
This class defines the exception error data.
RomaGetOptions - class com.candle.roma.kxc.RomaGetOptions.
The RomaGetOptions class encapsulates the criteria by which a Business Element retrieves a Client request or a Client retrieves a Business Service response.
RomaGetOptions() - Constructor for class com.candle.roma.kxc.RomaGetOptions
Constructs a new RomaGetOptions object with default options.
RomaGetOptions(RomaClientRequest) - Constructor for class com.candle.roma.kxc.RomaGetOptions
Constructs a new RomaGetOptions object initialising the theme, message id and correlation id from the supplied RomaClientRequest
RomaILSData - class com.candle.roma.kxc.RomaILSData.
This class encapsalates Roma Inline Service Data
RomaILSData() - Constructor for class com.candle.roma.kxc.RomaILSData
Constructor
RomaInteger - class com.candle.roma.kxc.RomaInteger.
This class provides an integer object to be used for a method integer parameter which must be passed by reference to allow a return value.
RomaInteger() - Constructor for class com.candle.roma.kxc.RomaInteger
 
RomaInteger(int) - Constructor for class com.candle.roma.kxc.RomaInteger
 
RomaLogInformation - class com.candle.roma.kxc.RomaLogInformation.
This class encapsulates the human-readable information that can be logged to an error log or sent as an alert.
RomaLogInformation() - Constructor for class com.candle.roma.kxc.RomaLogInformation
Constructs RomaLogInformation with a default message.
RomaMessageInfo - class com.candle.roma.kxc.RomaMessageInfo.
This class defines the message information.
RomaReportOptions - class com.candle.roma.kxc.RomaReportOptions.
This class contains the options that the application supplies when it invokes the Error Analysis Routine.
RomaReportOptions() - Constructor for class com.candle.roma.kxc.RomaReportOptions
Constructs a ReportOptions object with default attributes.
RomaRetrieveOptions - class com.candle.roma.kxc.RomaRetrieveOptions.
The RomaRetrieveOptions encapsulates the options available when retrieving a message from a storage queue.
RomaRetrieveOptions() - Constructor for class com.candle.roma.kxc.RomaRetrieveOptions
Construct a new RomaRetrieveOptions with default options.
RomaRoute - class com.candle.roma.kxc.RomaRoute.
This class defines the workflow route step.
RomaRoute() - Constructor for class com.candle.roma.kxc.RomaRoute
Constructs the empty object.
RomaSecurityDef - class com.candle.roma.kxc.RomaSecurityDef.
This class encapsulates the security information for an inline service.
RomaSecurityDef.SecBuffer - class com.candle.roma.kxc.RomaSecurityDef.SecBuffer.
Represents a single Roma security buffer within the security definition, which consists of a ILS number and data.
RomaSecurityDef() - Constructor for class com.candle.roma.kxc.RomaSecurityDef
Initializes an empty security definition.
RomaStorable - class com.candle.roma.kxc.RomaStorable.
This class extends the RomaMessage class to provide the ability to be used on storage queues.
RomaStorable() - Constructor for class com.candle.roma.kxc.RomaStorable
Default constructor.
RomaStorable(byte[], int) - Constructor for class com.candle.roma.kxc.RomaStorable
Constructor which takes a data buffer.
RomaStorable(RomaStorable) - Constructor for class com.candle.roma.kxc.RomaStorable
Constructor which takes a RomaStorable object.
RomaStorageQueue - class com.candle.roma.kxc.RomaStorageQueue.
The RomaStorageQueue class enables the storing and retrieval of message from a Roma storage queue.
RomaStorageQueue(RomaBusinessElement, String) - Constructor for class com.candle.roma.kxc.RomaStorageQueue
Contruct and open the named storage queue using a given business element.
RomaStorageQueue(RomaBusinessElement, String, int) - Constructor for class com.candle.roma.kxc.RomaStorageQueue
Contruct and open the named storage queue using a given business element.
RomaStorageQueue(RomaBusinessElement, String, int, String) - Constructor for class com.candle.roma.kxc.RomaStorageQueue
Contruct and open the named storage queue using a given business element.
RomaStorageQueue(RomaClient, String) - Constructor for class com.candle.roma.kxc.RomaStorageQueue
Construct and open the named storage queue using a given client.
RomaStorageQueue(RomaClient, String, int) - Constructor for class com.candle.roma.kxc.RomaStorageQueue
Construct and open the named storage queue using a given client.
RomaStorageQueue(RomaClient, String, int, String) - Constructor for class com.candle.roma.kxc.RomaStorageQueue
Construct and open the named storage queue using a given client.
RomaStoreOptions - class com.candle.roma.kxc.RomaStoreOptions.
This class encapsulates the options available when storing a message to a storage queue.
RomaStoreOptions() - Constructor for class com.candle.roma.kxc.RomaStoreOptions
Constructs a new instance with store options initialised to the default.
RomaSubject - class com.candle.roma.kxc.RomaSubject.
This class is used by applications to define the topic(s) for publish and subscribe operations.
RomaSubject(String) - Constructor for class com.candle.roma.kxc.RomaSubject
Initialize a new Subject, specifying subject name
RomaSubject(String, int) - Constructor for class com.candle.roma.kxc.RomaSubject
Initialize a new Subject, specifying subject and style
RomaSyncpointDef - class com.candle.roma.kxc.RomaSyncpointDef.
This class encapsulates a Roma syncpoint definition.
RomaSyncpointDef(int) - Constructor for class com.candle.roma.kxc.RomaSyncpointDef
Constructs a new RomaSyncpointDef object of the supplied syncpoint type.
RomaSystemConfig - class com.candle.roma.kxc.RomaSystemConfig.
This class defines the system environment configuration of the application.
RomaTheme - class com.candle.roma.kxc.RomaTheme.
This class encapsulates a Roma theme.
RomaTheme() - Constructor for class com.candle.roma.kxc.RomaTheme
Initializes a null theme.
RomaThemeInfo - class com.candle.roma.kxc.RomaThemeInfo.
This class defines the theme details extracted with the RomaBusinessElement.queryTheme(RomaTheme) or RomaClient.queryTheme(RomaTheme) method.
RomaThemeInfo() - Constructor for class com.candle.roma.kxc.RomaThemeInfo
Constructs the empty object.
RomaTrailer - class com.candle.roma.kxc.RomaTrailer.
This class defines the persistent trailer.
RomaTrailer(int, int, byte[]) - Constructor for class com.candle.roma.kxc.RomaTrailer
Constructs the object from the specified data.
RomaWorkflow - class com.candle.roma.kxc.RomaWorkflow.
This class defines the workflow.
RomaWorkflow() - Constructor for class com.candle.roma.kxc.RomaWorkflow
Constructs the empty object.
RomaWorkflowService - class com.candle.roma.kxc.RomaWorkflowService.
This class defines the business service associated with the workflow.
RomaWorkflowService() - Constructor for class com.candle.roma.kxc.RomaWorkflowService
Constructs the empty object.
ROUTEFLAG_NOTRANSFORM - Static variable in interface com.candle.roma.kxc.Roma
 
ROUTEFLAG_RESTRICTED - Static variable in interface com.candle.roma.kxc.Roma
 
ROUTEFLAG_XML_ILS - Static variable in interface com.candle.roma.kxc.Roma
 

S

SECONDARY_INFO - Static variable in interface com.candle.roma.kxc.Roma
 
SELECTOR - Static variable in interface com.candle.roma.kxc.Roma
 
sendAlert(RomaLogInformation) - Method in class com.candle.roma.kxc.RomaContext
Sends an alert message.
set(RomaTheme) - Method in class com.candle.roma.kxc.RomaTheme
Updates this object so that it represents an identical theme to the input RomaTheme object.
setAdditionalInfo(int, String) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets additional information.
setAnyTheme(boolean) - Method in class com.candle.roma.kxc.RomaGetOptions
Selects whether not to get message by matching theme when applying these options
setAnyTheme(boolean) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Selects whether not to get message by matching theme when applying these options
setApiProfileName(String) - Method in class com.candle.roma.kxc.RomaBeResponse
Associates an API profile with the put operation.
setApiProfileName(String) - Method in class com.candle.roma.kxc.RomaGetOptions
Sets the API profile name.
setApiProfileName(String) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Sets the API profile name.
setApiProfileName(String) - Method in class com.candle.roma.kxc.RomaClientRequest
Associates an API profile with the put operation.
setApiProfileName(String) - Method in class com.candle.roma.kxc.RomaStoreOptions
Associates an API profile with the put operation.
setApiProfileName(String) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Associates an API profile with the put operation.
setAudit(String) - Method in class com.candle.roma.kxc.RomaWorkflowService
Sets the audit object name to be used by the business service sending the message.
setBuffer(byte[], int, int) - Method in class com.candle.roma.kxc.RomaILSData
Set an ILS buffer.
setBuffer(int, byte[], int) - Method in class com.candle.roma.kxc.RomaSecurityDef
Define a new buffer for the specified inline service
setBusinessFlow(RomaBusinessFlow) - Method in class com.candle.roma.kxc.RomaContext
Sets the business flow information on the context.
setCallType(int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
set call type
setCloseTheme(boolean) - Method in class com.candle.roma.kxc.RomaBeResponse
Specify whether the theme should be closed automatically when the operation completes.
setCloseTheme(boolean) - Method in class com.candle.roma.kxc.RomaGetOptions
Specify whether the theme should be closed automatically when the operation completes.
setCloseTheme(boolean) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Specify whether the theme should be closed automatically when the operation completes.
setCloseTheme(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
Specify whether the theme should be closed automatically when the operation completes.
setCloseTheme(boolean) - Method in class com.candle.roma.kxc.RomaStoreOptions
Selects whether of not the theme is to be closed or retained in the put operation.
setCloseTheme(boolean) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Specify whether the theme should be closed automatically when the operation completes.
setCOA(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
set or clear confirmation of arrival flag
setCOD(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
set or clear confirmation of delivery flag
setCodepage(int) - Method in class com.candle.roma.kxc.RomaBeResponse
Set a new message codepage value.
setCodepage(int) - Method in class com.candle.roma.kxc.RomaStorable
Set a new message codepage value.
setCodepage(int) - Method in class com.candle.roma.kxc.RomaClientRequest
Set a new message codepage value.
setCodepage(int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Set a new message codepage value.
setCompCode(int, int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
set completion code
setComponent(String) - Method in class com.candle.roma.kxc.RomaWorkflowService
Sets the name of the business component sending the message.
setConfirmFlags(int) - Method in class com.candle.roma.kxc.RomaThemeInfo
Sets the confirmation flags.
setContext(byte[]) - Method in class com.candle.roma.kxc.RomaSyncpointDef
Sets the context if GLOBAL syncpointing is in effect.
setCorrelId(byte[]) - Method in class com.candle.roma.kxc.RomaBeResponse
Set the message correlation identifier.
setCorrelId(byte[]) - Method in class com.candle.roma.kxc.RomaStorable
Set the message correlation identifier.
setCorrelId(byte[]) - Method in class com.candle.roma.kxc.RomaGetOptions
Sets the correlation identifier.
setCorrelId(byte[]) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Sets the correlation identifier.
setCorrelId(byte[]) - Method in class com.candle.roma.kxc.RomaClientRequest
Set the message correlation identifier.
setCorrelId(byte[]) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Set the message correlation identifier.
setData(byte[]) - Method in class com.candle.roma.kxc.RomaTrailer
Sets the trailer data.
setDatagram(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
Sets the datagram flag.
setDefaultActions(int) - Method in class com.candle.roma.kxc.RomaReportOptions
Sets the default actions that should be carried out.
setDN(String) - Method in class com.candle.roma.kxc.RomaDirectoryItem
Set the distinguished name
setElements(int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets which element should be present in the exception message.
setEncoding(int) - Method in class com.candle.roma.kxc.RomaBeResponse
Set the message encoding.
setEncoding(int) - Method in class com.candle.roma.kxc.RomaStorable
Set the message encoding.
setEncoding(int) - Method in class com.candle.roma.kxc.RomaClientRequest
Set the message encoding.
setEncoding(int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Set the message encoding.
setErrorProfileName(String) - Method in class com.candle.roma.kxc.RomaReportOptions
Sets the error profile name.
setErrorProfileName(String) - Method in class com.candle.roma.kxc.RomaBeResponse
Associates an error profile with the put operation.
setErrorProfileName(String) - Method in class com.candle.roma.kxc.RomaGetOptions
Sets the error profile name.
setErrorProfileName(String) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Sets the error profile name.
setErrorProfileName(String) - Method in class com.candle.roma.kxc.RomaClientRequest
Associates an error profile with the put operation.
setErrorProfileName(String) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Associates an error profile with the put operation.
setErrorType(int, int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets error type.
setEteInfo(RomaEteInfo) - Method in class com.candle.roma.kxc.RomaThemeInfo
Sets the end-to-end and in-flight information.
setExpiry(int) - Method in class com.candle.roma.kxc.RomaBeResponse
Set a new message expiry time.
setExpiry(int) - Method in class com.candle.roma.kxc.RomaStorable
Set a new message expiry time in seconds.
setExpiry(int) - Method in class com.candle.roma.kxc.RomaClientRequest
Set a new message expiry time.
setExpiry(int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Set a new message expiry time.
setFeedback(int) - Method in class com.candle.roma.kxc.RomaBeResponse
Sets a new message feedback code.
setFeedback(int) - Method in class com.candle.roma.kxc.RomaStorable
Sets a new message feedback code.
setFeedback(int) - Method in class com.candle.roma.kxc.RomaClientRequest
Sets a new message feedback code.
setFeedback(int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets a new message feedback code.
setFlags(int) - Method in class com.candle.roma.kxc.RomaRoute
Sets the route flags.
setFlowName(String) - Method in class com.candle.roma.kxc.RomaBusinessFlow
Sets the business flow name.
setFormat(int) - Method in class com.candle.roma.kxc.RomaBeResponse
Set a new message format value.
setFormat(int) - Method in class com.candle.roma.kxc.RomaStorable
Set a new message format value.
setFormat(int) - Method in class com.candle.roma.kxc.RomaClientRequest
Set a new message format value.
setFormat(int) - Method in class com.candle.roma.kxc.RomaLogInformation
Sets format flags.
setFormat(int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Set a new message format value.
setFormatName(String) - Method in class com.candle.roma.kxc.RomaBeResponse
Sets the format name.
setFormatName(String) - Method in class com.candle.roma.kxc.RomaStorable
Sets the format name.
setFormatName(String) - Method in class com.candle.roma.kxc.RomaClientRequest
Sets the format name.
setFormatName(String) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets the format name.
setILSData(RomaILSData) - Method in class com.candle.roma.kxc.RomaBeResponse
Set outgoing ILS data
setILSData(RomaILSData) - Method in class com.candle.roma.kxc.RomaGetOptions
Set outgoing ILS data
setILSData(RomaILSData) - Method in class com.candle.roma.kxc.RomaClientRequest
Set outgoing ILS data
setIncrementRetryCount(boolean) - Method in class com.candle.roma.kxc.RomaBeResponse
Enables or disables the option to reset the retry count when sending the message.
setIncrementRetryCount(boolean) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Enables or disables the option to reset the retry count when sending the message.
setItemMustExist(boolean) - Method in class com.candle.roma.kxc.RomaDirectoryItem
Specify if an item with the same DN must or must not exist at the time that a DirectoryAgent attempts to store this item By default, the update is forced through.
setItemMustNotExist(boolean) - Method in class com.candle.roma.kxc.RomaDirectoryItem
Specify if an item with the same DN must or must not exist at the time that a DirectoryAgent attempts to store this item By default, the update is forced through.
setMethod(int) - Method in class com.candle.roma.kxc.RomaTrailer
Sets the ILS number of the trailer.
setMsgBuffer(byte[]) - Method in class com.candle.roma.kxc.RomaBeResponse
Sets message data.
setMsgBuffer(byte[]) - Method in class com.candle.roma.kxc.RomaClientRequest
Sets message data.
setMsgBuffer(byte[]) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets message data.
setMsgBuffer(byte[], int) - Method in class com.candle.roma.kxc.RomaBeResponse
Set buffer containing the message data and the length of the message for a PUT request.
setMsgBuffer(byte[], int) - Method in class com.candle.roma.kxc.RomaStorable
Set buffer containing the message data and the length of the message for a PUT request.
setMsgBuffer(byte[], int) - Method in class com.candle.roma.kxc.RomaClientRequest
Set buffer containing the message data and the length of the message for a PUT request.
setMsgBuffer(byte[], int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Set buffer containing the message data and the length of the message for a PUT request.
setMsgBuffer(String) - Method in class com.candle.roma.kxc.RomaBeResponse
Sets message data.
setMsgBuffer(String) - Method in class com.candle.roma.kxc.RomaClientRequest
Sets message data.
setMsgBuffer(String) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets message data.
setMsgId(byte[]) - Method in class com.candle.roma.kxc.RomaBeResponse
Set the message identifier.
setMsgId(byte[]) - Method in class com.candle.roma.kxc.RomaStorable
Set the message identifier.
setMsgId(byte[]) - Method in class com.candle.roma.kxc.RomaGetOptions
Sets the message identifier.
setMsgId(byte[]) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Sets the message identifier.
setMsgId(byte[]) - Method in class com.candle.roma.kxc.RomaClientRequest
Set the message identifier.
setMsgId(byte[]) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Set the message identifier.
setMsgName(String) - Method in class com.candle.roma.kxc.RomaBeResponse
Set the name of this message
setMsgName(String) - Method in class com.candle.roma.kxc.RomaStorable
Set the name of this message
setMsgName(String) - Method in class com.candle.roma.kxc.RomaClientRequest
Set the name of this message
setMsgName(String) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Set the name of this message
setName(String) - Method in class com.candle.roma.kxc.RomaBusinessService
Sets the service name.
setNewTheme(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
Specify whether a new theme should be allocated.
setNewTheme(boolean) - Method in class com.candle.roma.kxc.RomaStoreOptions
Selects whether or not a new theme will be allocated when applying these options.
setNewTheme(boolean) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Specify whether a new theme should be allocated.
setNoAlert(boolean) - Method in class com.candle.roma.kxc.RomaReportOptions
Enable or disable the option to prevent alerts from being sent.
setNoEms(boolean) - Method in class com.candle.roma.kxc.RomaReportOptions
Enable or disable the option to put the message to the exception management service if the report error operation fails.
setNoEms(boolean) - Method in class com.candle.roma.kxc.RomaBeResponse
Enables or disables the option to send the message to an exception message service if the put operation fails.
setNoEms(boolean) - Method in class com.candle.roma.kxc.RomaGetOptions
Specifies whether or not a get failure is to result in a message send to the Exception Message Queue.
setNoEms(boolean) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Specifies whether or not a get failure is to result in a message send to the Exception Message Queue.
setNoEms(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
Enables or disables the option to send the message to an exception message service if the put operation fails.
setNoEms(boolean) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Enables or disables the option to send the message to an exception message service if the put operation fails.
setNoNotification(boolean) - Method in class com.candle.roma.kxc.RomaReportOptions
Enable or disable the option to send a notification message to the client if the report error operation fails.
setNoNotification(boolean) - Method in class com.candle.roma.kxc.RomaBeResponse
Enables or disables the option to send a notification message back to the sender if the message get operation fails.
setNoNotification(boolean) - Method in class com.candle.roma.kxc.RomaGetOptions
Specify if a notification message is to be sent to the original sender if the get failed.
setNoNotification(boolean) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Specify if a notification message is to be sent to the original sender if the get failed.
setNoNotification(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
Enables or disables the option to send a notification message back to the sender if the message get operation fails.
setNoNotification(boolean) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Enables or disables the option to send a notification message back to the sender if the message get operation fails.
setNoSyncAllowed(boolean) - Method in class com.candle.roma.kxc.RomaBeResponse
Controls whether an MSMQ message can be placed outside syncpoint control.
setNoSyncAllowed(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
Controls whether an MSMQ message can be placed outside syncpoint control.
setNoSyncAllowed(boolean) - Method in class com.candle.roma.kxc.RomaStoreOptions
Controls whether an MSMQ message can be placed outside syncpoint control.
setNoSyncAllowed(boolean) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Controls whether an MSMQ message can be placed outside syncpoint control.
setNotification(boolean) - Method in class com.candle.roma.kxc.RomaBeResponse
Set or clear notification flag
setNoTransformation(boolean) - Method in class com.candle.roma.kxc.RomaReportOptions
Enable or disable the option to send an error profiling message to a transformation engine if the message type is not recognised.
setNoTransformation(boolean) - Method in class com.candle.roma.kxc.RomaBeResponse
Enables or disables the option to send the message to a message transformation service if the next component in the workflow cannot accept the message format.
setNoTransformation(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
Enables or disables the option to send the message to a message transformation service if the next component in the workflow cannot accept the message format.
setNoTransformation(boolean) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Enables or disables the option to send the message to a message transformation service if the next component in the workflow cannot accept the message format.
setNull() - Method in class com.candle.roma.kxc.RomaTheme
Updates object to represent a null theme.
setOperation(int) - Method in class com.candle.roma.kxc.RomaGetOptions
Set only the receive options of the object.
setOperation(int) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Set only the receive options of the object.
setOperationName(String) - Method in class com.candle.roma.kxc.RomaBusinessFlow
Sets the operation name.
setOperationType(int, int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets the operation type value.
setPersistence(int) - Method in class com.candle.roma.kxc.RomaBeResponse
Set a new value for the message perisitence.
setPersistence(int) - Method in class com.candle.roma.kxc.RomaStorable
Set a new value for the message perisitence.
setPersistence(int) - Method in class com.candle.roma.kxc.RomaClientRequest
Set a new value for the message perisitence.
setPersistence(int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Set a new value for the message perisitence.
setPosition(int, int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets error position.
setPriority(int) - Method in class com.candle.roma.kxc.RomaBeResponse
Set the message priority.
setPriority(int) - Method in class com.candle.roma.kxc.RomaStorable
Set the message priority.
setPriority(int) - Method in class com.candle.roma.kxc.RomaClientRequest
Set the message priority.
setPriority(int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Set the message priority.
setReason(int, int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets the reason code.
setReplace(boolean) - Method in class com.candle.roma.kxc.RomaILSData
Set option to replace.
setRetainTheme(boolean) - Method in class com.candle.roma.kxc.RomaBeResponse
Specify whether the theme should be retained for future operations.
setRetainTheme(boolean) - Method in class com.candle.roma.kxc.RomaGetOptions
Specify whether the theme should be retained for future operations.
setRetainTheme(boolean) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Specify whether the theme should be retained for future operations.
setRetainTheme(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
Specify whether the theme should be retained for future operations.
setRetainTheme(boolean) - Method in class com.candle.roma.kxc.RomaStoreOptions
Selects whether or not the theme is to be closed or else retained in the put operation.
setRetainTheme(boolean) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Specify whether the theme should be retained for future operations.
setRetryCount(int) - Method in class com.candle.roma.kxc.RomaThemeInfo
Sets the retry count.
setReturnCode(int, int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
set return code
setRoutes(Collection) - Method in class com.candle.roma.kxc.RomaWorkflow
Sets the route steps of the workflow.
setSecurityDef(RomaSecurityDef) - Method in class com.candle.roma.kxc.RomaBeResponse
Set security definition
setSecurityDef(RomaSecurityDef) - Method in class com.candle.roma.kxc.RomaGetOptions
Sets the security definition.
setSecurityDef(RomaSecurityDef) - Method in class com.candle.roma.kxc.RomaClientRequest
Set security definition
setSelector(int) - Method in class com.candle.roma.kxc.RomaBeResponse
Sets the put selector.
setSelector(int) - Method in class com.candle.roma.kxc.RomaGetOptions
Sets the message selection criteria.
setSelector(int) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Sets the message selection criteria.
setSelector(int) - Method in class com.candle.roma.kxc.RomaClientRequest
Sets the put selector.
setSelector(int) - Method in class com.candle.roma.kxc.RomaStoreOptions
Sets the put selector.
setSelector(int) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Sets the put selector.
setService(String) - Method in class com.candle.roma.kxc.RomaWorkflowService
Sets the name of the business service sending the message.
setServiceName(String) - Method in class com.candle.roma.kxc.RomaClientRequest
Sets the name of the Roma Business Service that a put operation will send this request to.
setServiceName(String) - Method in class com.candle.roma.kxc.RomaExceptionOptions
The name of the Business Service that defines the exception message queue.
setSeverity(int) - Method in class com.candle.roma.kxc.RomaLogInformation
Sets severity of the error.
setSourceFlow(String) - Method in class com.candle.roma.kxc.RomaWorkflowService
Sets the name of the business flow.
setSourceFlow(String) - Method in class com.candle.roma.kxc.RomaRoute
Sets the name of the business flow that has updated the route step.
setSourceOperation(String) - Method in class com.candle.roma.kxc.RomaWorkflowService
Sets the operation name.
setSourceOperation(String) - Method in class com.candle.roma.kxc.RomaRoute
Sets the name of the operation that has updated the route step.
setSourceService(String) - Method in class com.candle.roma.kxc.RomaRoute
Sets the name of the business service created the route step.
setStatus(int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets the error status.
setSubject(String) - Method in class com.candle.roma.kxc.RomaSubject
Set the subject string
setSubjectStyle(int) - Method in class com.candle.roma.kxc.RomaGetOptions
Sets the subject style for any receiving publications
setSubjectStyle(int) - Method in class com.candle.roma.kxc.RomaSubject
Set the subject style
setSuppressErrorProfile(boolean) - Method in class com.candle.roma.kxc.RomaBeResponse
Specify if error profiling is to be suppressed
setSuppressErrorProfile(boolean) - Method in class com.candle.roma.kxc.RomaGetOptions
Specify if error profiling is to be suppressed
setSuppressErrorProfile(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
Specify if error profiling is to be suppressed
setSyncpointDef(RomaSyncpointDef) - Method in class com.candle.roma.kxc.RomaReportOptions
Specify sync point definitiion
setSyncpointDef(RomaSyncpointDef) - Method in class com.candle.roma.kxc.RomaBeResponse
Specify sync point definitiion
setSyncpointDef(RomaSyncpointDef) - Method in class com.candle.roma.kxc.RomaGetOptions
Specify sync point definitiion
setSyncpointDef(RomaSyncpointDef) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Specify sync point definitiion
setSyncpointDef(RomaSyncpointDef) - Method in class com.candle.roma.kxc.RomaClientRequest
Specify sync point definitiion
setSyncpointDef(RomaSyncpointDef) - Method in class com.candle.roma.kxc.RomaStoreOptions
Specify sync point definitiion
setSyncpointDef(RomaSyncpointDef) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Specify sync point definitiion
setTagBuffer(byte[]) - Method in class com.candle.roma.kxc.RomaBeResponse
Sets tag data.
setTagBuffer(byte[]) - Method in class com.candle.roma.kxc.RomaClientRequest
Sets tag data.
setTagBuffer(byte[]) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets tag data.
setTagBuffer(byte[], int) - Method in class com.candle.roma.kxc.RomaBeResponse
Set buffer containing the tag data and the length of the tag for a PUT request.
setTagBuffer(byte[], int) - Method in class com.candle.roma.kxc.RomaClientRequest
Set buffer containing the tag data and the length of the tag for a PUT request.
setTagBuffer(byte[], int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Set buffer containing the tag data and the length of the tag for a PUT request.
setTagBuffer(String) - Method in class com.candle.roma.kxc.RomaBeResponse
Sets tag data.
setTagBuffer(String) - Method in class com.candle.roma.kxc.RomaClientRequest
Sets tag data.
setTagBuffer(String) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets tag data.
setTargetCodePage(String) - Method in class com.candle.roma.kxc.RomaRoute
Sets the target code page.
setTargetComponent(String) - Method in class com.candle.roma.kxc.RomaRoute
Sets the target business component name.
setTargetElement(String) - Method in class com.candle.roma.kxc.RomaRoute
Sets the target business element name.
setTargetQueue(String) - Method in class com.candle.roma.kxc.RomaRoute
Sets the target queue name.
setTermSupported(boolean) - Method in class com.candle.roma.kxc.RomaBeResponse
Specify if termination is supported
setTermSupported(boolean) - Method in class com.candle.roma.kxc.RomaGetOptions
Specify if termination is supported
setTermSupported(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
Specify if termination is supported
setTermSupported(boolean) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Specify if termination is supported
setTheme(RomaTheme) - Method in class com.candle.roma.kxc.RomaReportOptions
Sets the theme.
setTheme(RomaTheme) - Method in class com.candle.roma.kxc.RomaBeResponse
Update the message theme.
setTheme(RomaTheme) - Method in class com.candle.roma.kxc.RomaStorable
Update the message theme.
setTheme(RomaTheme) - Method in class com.candle.roma.kxc.RomaGetOptions
Sets the theme.
setTheme(RomaTheme) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Sets the theme.
setTheme(RomaTheme) - Method in class com.candle.roma.kxc.RomaClientRequest
Update the message theme.
setTheme(RomaTheme) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Sets the theme.
setThemeControl(int) - Method in class com.candle.roma.kxc.RomaGetOptions
Sets the theme.
setThemeId(byte[]) - Method in class com.candle.roma.kxc.RomaThemeInfo
Sets the theme ID.
setTrailers(Collection) - Method in class com.candle.roma.kxc.RomaThemeInfo
Sets the persistent trailers overwriting whatever persistent trailers already exist.
setType(int) - Method in class com.candle.roma.kxc.RomaTrailer
Sets the ILS type of the trailer.
setType(int) - Method in class com.candle.roma.kxc.RomaSyncpointDef
Sets the type of syncpoint.
setType(int) - Method in class com.candle.roma.kxc.RomaRoute
Sets the route type.
setUseApiProfile(boolean) - Method in class com.candle.roma.kxc.RomaBeResponse
Indicates that flags and options specified in the API profile should be used for the Roma put operation.
setUseApiProfile(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
Indicates that flags and options specified in the API profile should be used for the Roma put operation.
setUseApiProfile(boolean) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Indicates that flags and options specified in the API profile should be used for the Roma put operation.
setUserBuffer(byte[]) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets user data.
setUserBuffer(byte[], int) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets user data buffer.
setUserBuffer(String) - Method in class com.candle.roma.kxc.RomaExceptionMessage
Sets user data.
setUserData(byte[], int) - Method in class com.candle.roma.kxc.RomaLogInformation
Sets the user data part of the log or alert message.
setUserData(String) - Method in class com.candle.roma.kxc.RomaLogInformation
Sets the user data part of the log or alert message.
setUserText(String) - Method in class com.candle.roma.kxc.RomaLogInformation
Sets the user text, which will be included in the log or alert message.
setUseTheme(boolean) - Method in class com.candle.roma.kxc.RomaBeResponse
Specify whether an existing theme should be used.
setUseTheme(boolean) - Method in class com.candle.roma.kxc.RomaGetOptions
Selects whether or not a new theme will be allocated when applying these options
setUseTheme(boolean) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Selects whether or not a new theme will be allocated when applying these options
setUseTheme(boolean) - Method in class com.candle.roma.kxc.RomaClientRequest
Specify whether an existing theme should be used.
setUseTheme(boolean) - Method in class com.candle.roma.kxc.RomaStoreOptions
Selects whether or not a new theme will be allocated when applying these options
setUseTheme(boolean) - Method in class com.candle.roma.kxc.RomaExceptionOptions
Specify whether an existing theme should be used.
setValue(int) - Method in class com.candle.roma.kxc.RomaInteger
 
setWaitIndefinite() - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Sets an indefinite wait interval.
setWaitIndefinite(boolean) - Method in class com.candle.roma.kxc.RomaGetOptions
Sets whether to wait without timing out
setWaitIndefinite(boolean) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Sets whether to wait without timing out
setWaitInterval(int) - Method in class com.candle.roma.kxc.RomaGetOptions
Sets the wait interval in milliseconds.
setWaitInterval(int) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Sets the wait interval in milliseconds.
setWorkflow(RomaWorkflow) - Method in class com.candle.roma.kxc.RomaThemeInfo
Sets the workflow.
setWorkflowService(RomaWorkflowService) - Method in class com.candle.roma.kxc.RomaWorkflow
Associates the workflow service with the workflow.
SEV_ERROR - Static variable in interface com.candle.roma.kxc.Roma
An indication of the severity of the abnormality; in this case, a warning.
SEV_INFO - Static variable in interface com.candle.roma.kxc.Roma
An indication of the severity of the abnormality; in this case, for information only.
SEV_SEVERE - Static variable in interface com.candle.roma.kxc.Roma
An indication of the severity of the abnormality; in this case, a severe abnormality.
SEV_WARNING - Static variable in interface com.candle.roma.kxc.Roma
An indication of the severity of the abnormality; in this case, a warning.
STATUS_AUTHENTICATED - Static variable in interface com.candle.roma.kxc.Roma
Message status value.
STATUS_NATIVE - Static variable in interface com.candle.roma.kxc.Roma
Message status value.
STATUS_NONE - Static variable in interface com.candle.roma.kxc.Roma
Message status value.
STATUS_OK_TO_NOTIFY - Static variable in interface com.candle.roma.kxc.Roma
Message status value.
STATUS_OK_TO_RESPOND - Static variable in interface com.candle.roma.kxc.Roma
Message status value.
status() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the message status.
status() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the message status.
status() - Method in class com.candle.roma.kxc.RomaBeResponse
Return message status
status() - Method in class com.candle.roma.kxc.RomaError
Returns the error status.
status() - Method in class com.candle.roma.kxc.RomaClientRequest
Return message status
store(RomaStorable) - Method in class com.candle.roma.kxc.RomaStorageQueue
Store a message on the storage queue according to the defaulted options.
store(RomaStorable, RomaStoreOptions) - Method in class com.candle.roma.kxc.RomaStorageQueue
Store a message on the storage queue according to the supplied options.
storeItem(RomaDirectoryItem, String, String) - Method in class com.candle.roma.kxc.RomaDirectoryAgent
Store item with default options
STYLE_MQSERIES - Static variable in interface com.candle.roma.kxc.Roma
 
STYLE_ROMA - Static variable in interface com.candle.roma.kxc.Roma
 
STYLE_TIBRENDEZVOUS - Static variable in interface com.candle.roma.kxc.Roma
Subject style for publish/subscribe.
subject() - Method in class com.candle.roma.kxc.RomaClientResponse
Returns the subject name of the received message.
subscribe(RomaClientRequest, RomaSubject) - Method in class com.candle.roma.kxc.RomaClient
Subscribe to the specified subject.
SUBTREE - Static variable in interface com.candle.roma.kxc.Roma
Search type.
SYNC_GLOBAL - Static variable in interface com.candle.roma.kxc.Roma
Syncpoint type.
SYNC_LOCAL - Static variable in interface com.candle.roma.kxc.Roma
Syncpoint type.
SYNC_NONE - Static variable in interface com.candle.roma.kxc.Roma
Syncpoint type.
SYNC_PROFILE - Static variable in interface com.candle.roma.kxc.Roma
Syncpoint type.

T

tagBuffer() - Method in class com.candle.roma.kxc.RomaBeRequest
Return message tag buffer.
tagBuffer() - Method in class com.candle.roma.kxc.RomaClientResponse
Return reference to the message tag buffer.
tagDataLength() - Method in class com.candle.roma.kxc.RomaBeRequest
Return message data buffer length.
tagDataLength() - Method in class com.candle.roma.kxc.RomaClientResponse
Return message data buffer length.
THEME_CLOSE - Static variable in interface com.candle.roma.kxc.Roma
Theme control option that specifies if theme will be closed or retained by the RomaClient/RomaBusinessElement.get() method; in this case, close theme.
THEME_CONTROL - Static variable in interface com.candle.roma.kxc.Roma
 
THEME_DEFAULT_CONTROL - Static variable in interface com.candle.roma.kxc.Roma
Theme control option that specifies if theme is to be closed or retained by the method retrieving the message.
THEME_RETAIN - Static variable in interface com.candle.roma.kxc.Roma
Theme control option that specifies if theme will be closed or retained by the RomaClient/RomaBusinessElement.get() method; in this case, retain theme.
THEME_USAGE - Static variable in interface com.candle.roma.kxc.Roma
 
theme() - Method in class com.candle.roma.kxc.RomaBeRequest
Return the message theme.
theme() - Method in class com.candle.roma.kxc.RomaClientResponse
Return the message theme.
theme() - Method in class com.candle.roma.kxc.RomaBeResponse
Return the message theme.
theme() - Method in class com.candle.roma.kxc.RomaStorable
Return the message theme.
theme() - Method in class com.candle.roma.kxc.RomaClientRequest
Return the message theme.
theme() - Method in class com.candle.roma.kxc.RomaExceptionMessage
Return the message theme.
THEMEINFO_ALL - Static variable in interface com.candle.roma.kxc.Roma
 
THEMEINFO_CONFIRMFLAGS - Static variable in interface com.candle.roma.kxc.Roma
 
THEMEINFO_ETEINFO - Static variable in interface com.candle.roma.kxc.Roma
 
THEMEINFO_RETRYCOUNT - Static variable in interface com.candle.roma.kxc.Roma
 
THEMEINFO_THEMEID - Static variable in interface com.candle.roma.kxc.Roma
 
THEMEINFO_TRAILERS - Static variable in interface com.candle.roma.kxc.Roma
 
THEMEINFO_WORKFLOW - Static variable in interface com.candle.roma.kxc.Roma
 
timeStamp() - Method in class com.candle.roma.kxc.RomaBeRequest
Returns the time stamp which, for get operations, is the time at which the put operation occurred.
timeStamp() - Method in class com.candle.roma.kxc.RomaClientResponse
Returns the time stamp which, for get operations, is the time at which the put operation occurred.
timeStamp() - Method in class com.candle.roma.kxc.RomaStorable
Returns the time stamp which, for get operations, is the time at which the put operation occurred.

U

unsubscribe(RomaClientRequest, RomaSubject) - Method in class com.candle.roma.kxc.RomaClient
Unsubscribe to the specified subject.
USE_CORRELID - Static variable in interface com.candle.roma.kxc.Roma
 
USE_MSGID - Static variable in interface com.candle.roma.kxc.Roma
 
USE_MSGID_AND_CORRELID - Static variable in interface com.candle.roma.kxc.Roma
 
USE_NO_BASE - Static variable in interface com.candle.roma.kxc.Roma
Search option.
USE_NONE - Static variable in interface com.candle.roma.kxc.Roma
 
USE_ROMA_BASE - Static variable in interface com.candle.roma.kxc.Roma
Search option.
useApiProfile(boolean) - Method in class com.candle.roma.kxc.RomaGetOptions
Indicates that flags and options specified in the API profile should be used for the Roma put operation.
useApiProfile(boolean) - Method in class com.candle.roma.kxc.RomaRetrieveOptions
Indicates that flags and options specified in the API profile should be used for the Roma put operation.

W

writeLog(RomaLogInformation) - Static method in class com.candle.roma.kxc.RomaContext
Writes entry to the system log.

A B C D E F G H I L M N O P Q R S T U W