Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-03

oracle.apps.fnd.applcore.messages.messageService.applicationModule
Class MessageServiceAMImpl

java.lang.Object
  extended by oracle.jbo.common.NamedObjectImpl
      extended by oracle.jbo.server.NamedObjectImpl
          extended by oracle.jbo.server.ComponentObjectImpl
              extended by oracle.jbo.server.ContainerObjectImpl
                  extended by oracle.jbo.server.ApplicationModuleImpl
                      extended by oracle.apps.fnd.applcore.oaext.model.OAApplicationModuleImpl
                          extended by oracle.apps.fnd.applcore.messages.messageService.applicationModule.MessageServiceAMImpl
All Implemented Interfaces:
java.util.EventListener, MessageServiceAM, OAApplicationModule, OASeedDataService, oracle.jbo.ApplicationModule, oracle.jbo.common.TransPostControl, oracle.jbo.common.ws.WSApplicationModuleMarshaller, oracle.jbo.ComponentObject, oracle.jbo.ExprWrappable, oracle.jbo.GenericHints, oracle.jbo.OperationContainer, oracle.jbo.Properties, oracle.jbo.server.ContainerObject, oracle.jbo.server.TransactionListener, oracle.jbo.VariableManagerOwner, oracle.jbo.VariableManagerOwnerBase, oracle.jbo.WarningContainer, oracle.svcmsg.SvcMsgReceiver, oracle.svcmsg.SvcMsgSender
Direct Known Subclasses:
MessageWSAMImpl

public class MessageServiceAMImpl
extends OAApplicationModuleImpl
implements MessageServiceAM

Service for managing messages and message tokens. ApplCore provides standalone services for each category of functionality that you wish to use. These services leverage standard ADFBC development process. The service context that gets generated is a standard ADFBC Service/AM. We have provided an extended AM method that will allow you to instantiate any ApplCore service/AM and nest that AM under your root application module so the ApplCore services share the same connection with your main transaction. It's critical that we share the connection object so each thread does not consume more than one database connection.

The message service nested under root AM can be retrieved by calling MessageServiceAMImpl messageService = (MessageServiceAMImpl) ((OAApplicationModuleImpl)(getDBTransaction() .getRootApplicationModule())) .getFNDNestedService(OAConstants.MESSAGE_SERVICE);


Field Summary
 
Fields inherited from class oracle.apps.fnd.applcore.oaext.model.OAApplicationModuleImpl
RCS_ID
 
Fields inherited from class oracle.jbo.server.ApplicationModuleImpl
DEFAULT_DEF_NAME, SHARED_SCOPE_APPLICATION, SHARED_SCOPE_SESSION
 
Fields inherited from class oracle.jbo.server.ContainerObjectImpl
mComponentList, mComponents
 
Fields inherited from class oracle.jbo.common.NamedObjectImpl
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX
 
Fields inherited from interface oracle.jbo.ApplicationModule
ACTIVATE_CLIENT_FLAG, ACTIVATE_REMOVE_FLAG, ACTIVATE_SKIP_RESTORE_VO_FROM_DEF, ACTIVATE_TRANSIENT_FLAG, ACTIVATE_UNDO_FLAG, DEFAULT_DEF_FULL_NAME, DEFAULT_ROOT_APP_MOD_NAME, EFF_DT_PROPERTY_STR, IMAGE_LOC, PASSIVATE_DEFER_FLAG, PASSIVATE_HINT_FLAG, PASSIVATE_TO_DATABASE, PASSIVATE_TO_FILE, PASSIVATE_TO_MEMORY, PASSIVATE_TO_STACK_FLAG, PASSIVATE_TRANSIENT_FLAG, PASSIVATE_UNDO_FLAG, RELEASE_LEVEL_MANAGED, RELEASE_LEVEL_RESERVED, RELEASE_LEVEL_UNMANAGED, REMOVE_SNAPSHOT, RESET_CLIENT_ONLY_FLAG, RESET_INTERNAL_FLAG, RESET_KEEP_ALL_SNAPSHOTS_FLAG, RESET_MANAGE_SNAPSHOTS, RESET_RELOAD_FLAG, RESET_ROLLBACK_FLAG, SYNC_BATCH, SYNC_IMMEDIATE, SYNC_LAZY
 
Fields inherited from interface oracle.jbo.GenericHints
PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP
 
Fields inherited from interface oracle.apps.fnd.applcore.oaext.model.OASeedDataService
RCS_ID_RECORDED
 
Fields inherited from interface oracle.jbo.common.TransPostControl
TRANS_POST_GET_ATTR_BY_INDEX, TRANS_POST_GET_ATTR_BY_NAME, TRANS_POST_GET_ATTR_COUNT, TRANS_POST_GET_ATTR_INDEX_OF, TRANS_POST_GET_STRUCTURE_DEF, TRANS_POST_PUSHBACK, TRANS_POST_REFRESH_UNDO_CHANGES, TRANS_POST_REFRESH_WITH_DB_FORGET_CHANGES, TRANS_POST_REFRESH_WITH_DB_ONLY_IF_UNCHANGED, TRANS_POST_REMOVE, TRANS_POST_SET_ATTR_BY_INDEX, TRANS_POST_SET_ATTR_BY_NAME
 
Fields inherited from interface oracle.jbo.common.ws.WSApplicationModuleMarshaller
ACTIVATION_AFTER_LOSS_OF_AFFINITY, ACTIVATION_AFTER_RESTART, ACTIVATION_NONE, SYNC_INT_BATCH, SYNC_INT_BATCH_DO_WORK
 
Constructor Summary
MessageServiceAMImpl()
          This is the default constructor (do not remove).
 
Method Summary
 java.lang.String format(MessageVORow pMessage, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use link formatMap(oracle.apps.fnd.applcore.messages.messageService.MessageVORow, java.util.Map) instead
 java.lang.String formatAdminAction(MessageVORow pMessage, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use getMessageAdminAction(java.lang.String, java.lang.String, java.util.Map) instead
 java.lang.String formatAdminAction(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use getMessageAdminAction(java.lang.String, java.lang.String, java.util.Map) instead.
 java.lang.String formatAdminDetails(MessageVORow pMessage, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use getMessageAdminDetails(java.lang.String, java.lang.String, java.util.Map) instead.
 java.lang.String formatAdminDetails(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use #getMessageAdminDetails) instead.
 java.lang.String formatAdminText(MessageVORow pMessage, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use formatAdminTextMap(oracle.apps.fnd.applcore.messages.messageService.MessageVORow, java.util.Map) instead
 java.lang.String formatAdminTextMap(MessageVORow pMessage, java.util.Map<java.lang.String,java.lang.Object> pTokens)
          Return the full token substituted admin text of the message, in XML format.
 java.lang.String formatAdminTextMap(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.Map<java.lang.String,java.lang.Object> pTokens)
          Return the full token substituted admin text of the message, in XML format.
 java.lang.String formatCause(MessageVORow pMessage, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use instead
 java.lang.String formatCause(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use getMessageCause(java.lang.String, java.lang.String, java.util.Map) instead
 java.lang.String formatEncodedText(MessageVORow pMessage, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use getMessageEncodedText(java.lang.String, java.lang.String, java.util.Map) instead
 java.lang.String formatEncodedText(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use getMessageEncodedText(java.lang.String, java.lang.String, java.util.Map) instead.
 java.lang.String formatMap(MessageVORow pMessage, java.util.Map<java.lang.String,java.lang.Object> pTokens)
          Formats the entire message using the specified tokens.
 java.lang.String formatText(MessageVORow pMessage, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use getMessageText(java.lang.String, java.lang.String, java.util.Map) instead.
 java.lang.String formatText(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use getMessageText(java.lang.String, java.lang.String, java.util.Map) instead.
 java.lang.String formatUserAction(MessageVORow pMessage, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use getMessageUserAction(java.lang.String, java.lang.String, java.util.Map) instead.
 java.lang.String formatUserAction(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use getMessageUserAction(java.lang.String, java.lang.String, java.util.Map) instead.
 java.lang.String formatUserDetails(MessageVORow pMessage, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use getMessageUserDetails(java.lang.String, java.lang.String, java.util.Map) instead.
 java.lang.String formatUserDetails(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use getMessageUserDetails(java.lang.String, java.lang.String, java.util.Map) instead.
 java.lang.String formatUserText(MessageVORow pMessage, java.util.List<TokenValueVORow> pTokens)
          Deprecated. Use formatUserTextMap(oracle.apps.fnd.applcore.messages.messageService.MessageVORow, java.util.Map) instead
 java.lang.String formatUserTextMap(MessageVORow pMessage, java.util.Map<java.lang.String,java.lang.Object> pTokens)
          Return the token substituted full user version of the message, in XML format.
 java.lang.String formatUserTextMap(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.Map<java.lang.String,java.lang.Object> pTokens)
          Return the token substituted full user version of the message, in XML format.
 ApplicationPVOImpl getApplication()
          Container's getter for Application.
 MessageVORow getDefinedMessage(java.lang.String pAppShortName, java.lang.String pMessageName)
          Get the message from fnd message store based on the application name and the message name.
static MessageServiceAMImpl getInstance()
          Return an instance of this AM.
static MessageServiceAMImpl getInstance(java.lang.String pConfig)
          Return an instance of this AM.
 oracle.jbo.server.ApplicationModuleImpl getLookupServiceAM1()
          Container's getter for LookupServiceAM1.
 MessageVOImpl getMessage()
          Container's getter for Message.
 MessageVORow getMessage(java.lang.String pAppShortName, java.lang.String pMessageName)
          Get the message from fnd message store based on the application name and the message name.
 java.lang.String getMessageAdminAction(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.Map<java.lang.String,java.lang.Object> pTokens)
          Get the message admin action from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens.
 java.lang.String getMessageAdminDetails(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.Map<java.lang.String,java.lang.Object> pTokens)
          Get the message admin details from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens.
 java.lang.String getMessageCause(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.Map<java.lang.String,java.lang.Object> pTokens)
          Get the message cause from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens.
 java.lang.String getMessageEncodedText(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.Map<java.lang.String,java.lang.Object> pTokens)
          Get the message encoded text from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens.
 java.lang.String getMessageText(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.Map<java.lang.String,java.lang.Object> pTokens)
          Get the short message from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens.
 MessageTokenVOImpl getMessageToken()
          Container's getter for MessageToken.
 java.lang.String getMessageUserAction(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.Map<java.lang.String,java.lang.Object> pTokens)
          Get the message user action from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens.
 java.lang.String getMessageUserDetails(java.lang.String pAppShortName, java.lang.String pMessageName, java.util.Map<java.lang.String,java.lang.Object> pTokens)
          Get the message user details from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens.
 oracle.jbo.server.ViewLinkImpl getMessageVOToMessageToken()
          Container's getter for MessageVOToMessageToken.
 TokenValueVOImpl getTokenValue()
          Container's getter for TokenValue.
protected  void prepareSession(oracle.jbo.Session session)
           
 
Methods inherited from class oracle.apps.fnd.applcore.oaext.model.OAApplicationModuleImpl
getFNDNestedService, getFNDNestedService, getNLSLanguageForSeedData, getSeedContext, getSequenceValue, getSetId, invalidateSetIdCache, invalidateSetIdCache, isResetting, isSeedDataExtractMode, isSeedDataMode, isSeedDataUploadMode, isT2PMode, prepareSession, resetState, resetState, seedExtract, seedUpload, seedUpload, seedUpload, setNLSLanguageForSeedData, setSeedContext, setT2PMode, synchronizeApplSessionWithDB, unSetT2PMode
 
Methods inherited from class oracle.jbo.server.ApplicationModuleImpl
activate, activateConnectionState, activateOpenVOs, activateState, activateState, activateState, activateState, activateStateForUndo, addChild, addResponse, addWarning, afterActivation, afterCommit, afterConnect, afterRemove, afterRollback, afterValidate, beforeCommit, beforeDisconnect, beforeRollback, beforeValidate, bindToWorkingSet, clearVOCaches, createApplicationModule, createComponentObject, createCompositeViewDef, createRootApplicationModule, createSharedDataHandle, createViewLink, createViewLink, createViewLinkBetweenViewObjects, createViewLinkFromEntityAssocName, createViewObject, createViewObject, createViewObjectForDef, createViewObjectFromQueryClauses, createViewObjectFromQueryStmt, createViewObjectFromQueryStmt, createViewObjectOnEntity, createViewObjectOnRowSet, createWorkerApplicationModule, createXMLSharedDataHandle, detach, doMessage, doPoolMessage, dumpQueryResult, executeCommand, executeQueryOnViewObjects, fetchAttributeProperties, findApplicationModule, findComponentObject, findObject, findObject, findOrCreateSharedApplicationModule, findRSIForEntity, findViewLink, findViewObject, findViewObjectUsingEntity, findViewObjectWithParameters, findVOsWithEntityUsage, findVOsWithEntityUsage, finishLoadingComponents, finishSyncWorkingSet, getAMStatistics, getApplicationModuleDef, getApplicationModuleImpls, getApplicationModuleNames, getApplicationModuleNames, getAppModuleRequestHandler, getAttributeDefs, getAttributeDefs, getAttributeDefsForVO, getClientProxyClassName, getClientProxyClassName, getClientProxyInterfaceName, getComponentObjectNames, getComponentObjectNames, getCurrentWorkingSet, getDBTransaction, getDefFullName, getDefName, getEntityAttributesPermission, getEntityRowFromHandle, getExceptionHandler, getImageLoc, getListBindingName, getListBindingRSI, getMostRecentStackId, getObjectMarshaller, getPreferredListRSI, getReleaseLevel, getRemoteObjectId, getResponseName, getSession, getStyles, getSyncLock, getSyncMode, getTransaction, getTransactionInternal, getUserPrincipalName, getViewAttributesPermission, getViewLinkNames, getViewLinkNames, getViewLinks, getViewObjectNames, getViewObjectNames, getViewObjects, getWorkingSetMarshaller, handleDefinitionChangedOnActivate, hasPendingDataPosts, internalGetListBindingRSI, invokeMethod, isForRemote, isLoadComponentsLazily, isNameGenerated, isRoot, isTransientTransactionListener, isValidIdForUndo, launchTester, marshal, marshalForActivate, passivateConnectionState, passivateOpenVOs, passivateState, passivateState, passivateState, passivateState, passivateState, passivateStateForUndo, prepareApplicationModuleSession, prepareForActivation, prepareForPassivation, prepareSession, prepareViewObjects, processChangeNotifications, remove, removeChild, removeState, reservePassivationId, reserveSnapshotId, reset, resetState, selectAttributesForViewObjects, sendServiceMessage, sendWorkingSetRequests, setBoundToWorkingSet, setDataModelRefresh, setDBConnectionRequired, setExceptionHandler, setLoadComponentsLazily, setReleaseLevel, setRemoteAdapter, setSessionUserData, setStoreForPassiveState, setStyles, setSyncMode, setWorkingSetMarshaller, sync, syncMarshaller, syncWorkingSet, transformExceptionParams, transformExceptionParams, transPostGetAttr, transPostPushback, transPostRefresh, transPostRemove, transPostRevert, transPostRowOp, transPostSetAttr, transPostSetAttrValues
 
Methods inherited from class oracle.jbo.server.ContainerObjectImpl
addContainerListener, removeContainerListener
 
Methods inherited from class oracle.jbo.server.ComponentObjectImpl
addListener, applyPersonalization, create, createRef, createVariableValueManager, ensureVariableManager, findOperationDefinitions, findPersDefObject, getAllProperties, getApplicationModule, getCompListeners, getCompListenersList, getDefinitionManager, getFullNameForPersDef, getHintValue, getLabel, getLabelPlural, getMessageBundleClass, getProxyClassName, getProxyClassName, getResourceBundleDef, getRootApplicationModule, getStringFromMessageBundle, getTooltip, getVariableManager, hasVariables, isDead, isPersonalized, isRegWithPiggyMan, resolvePropertyRaw, setName, setParent, setProxyClassName
 
Methods inherited from class oracle.jbo.server.NamedObjectImpl
setParent, setPropertiesMap
 
Methods inherited from class oracle.jbo.common.NamedObjectImpl
allocatePropertyMap, getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionsMap, getPropertyMap, getResourcesFromBundle, isPropertyExpression, mergePropertyMap, refreshProperty, removeProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, setFullName, setPropertiesMap2, setProperty, setProperty, setPropertyExpression, setPropertyMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.jbo.ApplicationModule
activateState, activateState, activateState, activateStateForUndo, addWarning, clearVOCaches, createApplicationModule, createComponentObject, createCompositeViewDef, createViewLink, createViewLinkBetweenViewObjects, createViewLinkFromEntityAssocName, createViewObject, createViewObjectFromQueryClauses, createViewObjectFromQueryStmt, createViewObjectFromQueryStmt, createViewObjectOnEntity, createViewObjectOnRowSet, doPoolMessage, executeQueryOnViewObjects, fetchAttributeProperties, findApplicationModule, findComponentObject, findRSIForEntity, findViewLink, findViewObject, findViewObjectUsingEntity, findViewObjectWithParameters, getApplicationModuleNames, getApplicationModuleNames, getExceptionHandler, getListBindingName, getListBindingRSI, getMostRecentStackId, getPreferredListRSI, getReleaseLevel, getSession, getStyles, getSyncLock, getSyncMode, getTransaction, getViewLinkNames, getViewLinkNames, getViewObjectNames, getViewObjectNames, isRoot, isValidIdForUndo, passivateState, passivateState, passivateState, passivateState, passivateStateForUndo, prepareSession, prepareViewObjects, processChangeNotifications, removeState, reservePassivationId, reserveSnapshotId, resetState, resetState, setExceptionHandler, setReleaseLevel, setStoreForPassiveState, setStyles, setSyncMode, sync, transformExceptionParams
 
Methods inherited from interface oracle.jbo.ComponentObject
getDefFullName, getDefName, getFullName, getName, remove
 
Methods inherited from interface oracle.jbo.GenericHints
getHintValue, getLabel, getLabelPlural, getTooltip
 
Methods inherited from interface oracle.jbo.Properties
getProperties, getProperty, getProperty, refreshProperty
 
Methods inherited from interface oracle.jbo.VariableManagerOwner
getName
 

Constructor Detail

MessageServiceAMImpl

public MessageServiceAMImpl()
This is the default constructor (do not remove).

Method Detail

prepareSession

protected void prepareSession(oracle.jbo.Session session)
Overrides:
prepareSession in class OAApplicationModuleImpl

getInstance

public static final MessageServiceAMImpl getInstance(java.lang.String pConfig)
Return an instance of this AM. Warning! Callers are responible for calling Config.releaseRootApplicationModule() to release this AM when finished.

Parameters:
pConfig -
Returns:

getInstance

public static final MessageServiceAMImpl getInstance()
Return an instance of this AM. Warning! Callers are responible for calling Config.releaseRootApplicationModule() to release this AM when finished.

Returns:

getDefinedMessage

public MessageVORow getDefinedMessage(java.lang.String pAppShortName,
                                      java.lang.String pMessageName)
Get the message from fnd message store based on the application name and the message name. If the message doesn't exist, null is returned. To avoid checking for null return values see getMessage(String,String).

Parameters:
pAppShortName - Application Short Name
pMessageName - Message name
Returns:
Message object or null if the message is not defined

getMessage

public MessageVORow getMessage(java.lang.String pAppShortName,
                               java.lang.String pMessageName)
Get the message from fnd message store based on the application name and the message name. If the message does not exist, a placeholder message is returned. This allows for programming without having to check for null as well as an indication reminder for seeding the message.

Parameters:
pAppShortName - Application Short Name
pMessageName - Message name
Returns:
Message object

formatText

@Deprecated
public java.lang.String formatText(java.lang.String pAppShortName,
                                              java.lang.String pMessageName,
                                              java.util.List<TokenValueVORow> pTokens)
Deprecated. Use getMessageText(java.lang.String, java.lang.String, java.util.Map) instead.

Fetches the MessageText for the specified Application Short Name and Message Name and returns the MessageText formatted using the specified tokens.

Specified by:
formatText in interface MessageServiceAM
Parameters:
pAppShortName - the message's Application Short Name
pMessageName - the message name to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatUserDetails

@Deprecated
public java.lang.String formatUserDetails(java.lang.String pAppShortName,
                                                     java.lang.String pMessageName,
                                                     java.util.List<TokenValueVORow> pTokens)
Deprecated. Use getMessageUserDetails(java.lang.String, java.lang.String, java.util.Map) instead.

Fetches the MessageUserDetails for the specified Application Short Name and Message Name and returns the MessageUserDetails formatted using the specified tokens.

Specified by:
formatUserDetails in interface MessageServiceAM
Parameters:
pAppShortName - the message's Application Short Name
pMessageName - the message name to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatUserAction

@Deprecated
public java.lang.String formatUserAction(java.lang.String pAppShortName,
                                                    java.lang.String pMessageName,
                                                    java.util.List<TokenValueVORow> pTokens)
Deprecated. Use getMessageUserAction(java.lang.String, java.lang.String, java.util.Map) instead.

Fetches the MessageUserAction for the specified Application Short Name and Message Name and returns the MessageUserAction formatted using the specified tokens.

Specified by:
formatUserAction in interface MessageServiceAM
Parameters:
pAppShortName - the message's Application Short Name
pMessageName - the message name to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatAdminDetails

@Deprecated
public java.lang.String formatAdminDetails(java.lang.String pAppShortName,
                                                      java.lang.String pMessageName,
                                                      java.util.List<TokenValueVORow> pTokens)
Deprecated. Use #getMessageAdminDetails) instead.

Fetches the MessageAdminDetails for the specified Application Short Name and Message Name and returns the MessageAdminDetails formatted using the specified tokens.

Specified by:
formatAdminDetails in interface MessageServiceAM
Parameters:
pAppShortName - the message's Application Short Name
pMessageName - the message name to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatAdminAction

@Deprecated
public java.lang.String formatAdminAction(java.lang.String pAppShortName,
                                                     java.lang.String pMessageName,
                                                     java.util.List<TokenValueVORow> pTokens)
Deprecated. Use getMessageAdminAction(java.lang.String, java.lang.String, java.util.Map) instead.

Fetches the MessageAdminAction for the specified Application Short Name and Message Name and returns the MessageAdminAction formatted using the specified tokens.

Specified by:
formatAdminAction in interface MessageServiceAM
Parameters:
pAppShortName - the message's Application Short Name
pMessageName - the message name to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatCause

@Deprecated
public java.lang.String formatCause(java.lang.String pAppShortName,
                                               java.lang.String pMessageName,
                                               java.util.List<TokenValueVORow> pTokens)
Deprecated. Use getMessageCause(java.lang.String, java.lang.String, java.util.Map) instead

Fetches the MessageCause for the specified Application Short Name and Message Name and returns the MessageCause formatted using the specified tokens.

Specified by:
formatCause in interface MessageServiceAM
Parameters:
pAppShortName - the message's Application Short Name
pMessageName - the message name to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatEncodedText

@Deprecated
public java.lang.String formatEncodedText(java.lang.String pAppShortName,
                                                     java.lang.String pMessageName,
                                                     java.util.List<TokenValueVORow> pTokens)
Deprecated. Use getMessageEncodedText(java.lang.String, java.lang.String, java.util.Map) instead.

Fetches the MessageEncodedText for the specified Application Short Name and Message Name and returns the MessageEncodedText formatted using the specified tokens.

Specified by:
formatEncodedText in interface MessageServiceAM
Parameters:
pAppShortName - the message's Application Short Name
pMessageName - the message name to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatText

@Deprecated
public java.lang.String formatText(MessageVORow pMessage,
                                              java.util.List<TokenValueVORow> pTokens)
Deprecated. Use getMessageText(java.lang.String, java.lang.String, java.util.Map) instead.

Formats the MessageText of the specified Message using the specified tokens.

Specified by:
formatText in interface MessageServiceAM
Parameters:
pMessage - the message containing the text to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatUserTextMap

public java.lang.String formatUserTextMap(MessageVORow pMessage,
                                          java.util.Map<java.lang.String,java.lang.Object> pTokens)
Return the token substituted full user version of the message, in XML format.

This is an auto-logging enabled method.

Parameters:
pMessage - the message containing the text to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatUserTextMap

public java.lang.String formatUserTextMap(java.lang.String pAppShortName,
                                          java.lang.String pMessageName,
                                          java.util.Map<java.lang.String,java.lang.Object> pTokens)
Return the token substituted full user version of the message, in XML format.

This is an auto-logging enabled method.

Specified by:
formatUserTextMap in interface MessageServiceAM
Parameters:
pAppShortName - the message application short name
pMessageName - the message name containing the text to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatUserText

@Deprecated
public java.lang.String formatUserText(MessageVORow pMessage,
                                                  java.util.List<TokenValueVORow> pTokens)
Deprecated. Use formatUserTextMap(oracle.apps.fnd.applcore.messages.messageService.MessageVORow, java.util.Map) instead

Return the token substituted full user version of the message, in XML format.

This is an auto-logging enabled method.

Specified by:
formatUserText in interface MessageServiceAM
Parameters:
pMessage - the message containing the text to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatUserDetails

@Deprecated
public java.lang.String formatUserDetails(MessageVORow pMessage,
                                                     java.util.List<TokenValueVORow> pTokens)
Deprecated. Use getMessageUserDetails(java.lang.String, java.lang.String, java.util.Map) instead.

Formats the MessageUserDetails of the specified Message using the specified tokens.

Specified by:
formatUserDetails in interface MessageServiceAM
Parameters:
pMessage - the message containing the text to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatUserAction

@Deprecated
public java.lang.String formatUserAction(MessageVORow pMessage,
                                                    java.util.List<TokenValueVORow> pTokens)
Deprecated. Use getMessageUserAction(java.lang.String, java.lang.String, java.util.Map) instead.

Formats the MessageUserAction of the specified Message using the specified tokens.

Specified by:
formatUserAction in interface MessageServiceAM
Parameters:
pMessage - the message containing the text to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatAdminTextMap

public java.lang.String formatAdminTextMap(MessageVORow pMessage,
                                           java.util.Map<java.lang.String,java.lang.Object> pTokens)
Return the full token substituted admin text of the message, in XML format.

This is an auto-logging enabled method.

Parameters:
pMessage - the message containing the text to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatAdminTextMap

public java.lang.String formatAdminTextMap(java.lang.String pAppShortName,
                                           java.lang.String pMessageName,
                                           java.util.Map<java.lang.String,java.lang.Object> pTokens)
Return the full token substituted admin text of the message, in XML format.

This is an auto-logging enabled method.

Specified by:
formatAdminTextMap in interface MessageServiceAM
Parameters:
pAppShortName - the message application short name
pMessageName - the message containing the text to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatAdminText

@Deprecated
public java.lang.String formatAdminText(MessageVORow pMessage,
                                                   java.util.List<TokenValueVORow> pTokens)
Deprecated. Use formatAdminTextMap(oracle.apps.fnd.applcore.messages.messageService.MessageVORow, java.util.Map) instead

Return the full token substituted admin text of the message, in XML format.

This is an auto-logging enabled method.

Specified by:
formatAdminText in interface MessageServiceAM
Parameters:
pMessage -
pTokens -
Returns:

formatAdminDetails

@Deprecated
public java.lang.String formatAdminDetails(MessageVORow pMessage,
                                                      java.util.List<TokenValueVORow> pTokens)
Deprecated. Use getMessageAdminDetails(java.lang.String, java.lang.String, java.util.Map) instead.

Formats the MessageAdminDetails of the specified Message using the specified tokens.

Specified by:
formatAdminDetails in interface MessageServiceAM
Parameters:
pMessage - the message containing the text to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatAdminAction

@Deprecated
public java.lang.String formatAdminAction(MessageVORow pMessage,
                                                     java.util.List<TokenValueVORow> pTokens)
Deprecated. Use getMessageAdminAction(java.lang.String, java.lang.String, java.util.Map) instead

Formats the MessageAdminAction of the specified Message using the specified tokens.

Specified by:
formatAdminAction in interface MessageServiceAM
Parameters:
pMessage - the message containing the text to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatCause

@Deprecated
public java.lang.String formatCause(MessageVORow pMessage,
                                               java.util.List<TokenValueVORow> pTokens)
Deprecated. Use instead

Formats the MessageCause of the specified Message using the specified tokens.

Specified by:
formatCause in interface MessageServiceAM
Parameters:
pMessage - the message containing the text to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

formatEncodedText

@Deprecated
public java.lang.String formatEncodedText(MessageVORow pMessage,
                                                     java.util.List<TokenValueVORow> pTokens)
Deprecated. Use getMessageEncodedText(java.lang.String, java.lang.String, java.util.Map) instead

Formats the MessageText of the specified Message using the specified tokens.

Specified by:
formatEncodedText in interface MessageServiceAM
Parameters:
pMessage - the message containing the text to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message text

format

@Deprecated
public java.lang.String format(MessageVORow pMessage,
                                          java.util.List<TokenValueVORow> pTokens)
Deprecated. Use link formatMap(oracle.apps.fnd.applcore.messages.messageService.MessageVORow, java.util.Map) instead

Formats the entire message using the specified tokens. The token-substituted message will be returned in XML format. Auto-logging is performed.

Parameters:
pMessage - the message to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message in XML format

formatMap

public java.lang.String formatMap(MessageVORow pMessage,
                                  java.util.Map<java.lang.String,java.lang.Object> pTokens)
Formats the entire message using the specified tokens. The token-substituted message will be returned in XML format. Auto-logging is performed.

Parameters:
pMessage - the message to format
pTokens - the tokens to replace in the message
Returns:
token-replaced message in XML format

getMessageText

public java.lang.String getMessageText(java.lang.String pAppShortName,
                                       java.lang.String pMessageName,
                                       java.util.Map<java.lang.String,java.lang.Object> pTokens)
Get the short message from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens. Message text is returned in plain text, not XML.

Specified by:
getMessageText in interface MessageServiceAM
Parameters:
pAppShortName - Application Short name
pMessageName - Message name
pTokens - Replacement Tokens
Returns:
Formatted message short text

getMessageUserDetails

public java.lang.String getMessageUserDetails(java.lang.String pAppShortName,
                                              java.lang.String pMessageName,
                                              java.util.Map<java.lang.String,java.lang.Object> pTokens)
Get the message user details from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens. Message text is returned in plain text, not XML.

Specified by:
getMessageUserDetails in interface MessageServiceAM
Parameters:
pAppShortName - Application Short name
pMessageName - Message name
pTokens - Replacement Tokens
Returns:
Formatted message user details text

getMessageAdminDetails

public java.lang.String getMessageAdminDetails(java.lang.String pAppShortName,
                                               java.lang.String pMessageName,
                                               java.util.Map<java.lang.String,java.lang.Object> pTokens)
Get the message admin details from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens. Message text is returned in plain text, not XML.

Specified by:
getMessageAdminDetails in interface MessageServiceAM
Parameters:
pAppShortName - Application Short name
pMessageName - Message name
pTokens - Replacement Tokens
Returns:
Formatted message admin details text

getMessageUserAction

public java.lang.String getMessageUserAction(java.lang.String pAppShortName,
                                             java.lang.String pMessageName,
                                             java.util.Map<java.lang.String,java.lang.Object> pTokens)
Get the message user action from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens. Message text is returned in plain text, not XML.

Specified by:
getMessageUserAction in interface MessageServiceAM
Parameters:
pAppShortName - Application Short name
pMessageName - Message name
pTokens - Replacement Tokens
Returns:
Formatted message user action text

getMessageAdminAction

public java.lang.String getMessageAdminAction(java.lang.String pAppShortName,
                                              java.lang.String pMessageName,
                                              java.util.Map<java.lang.String,java.lang.Object> pTokens)
Get the message admin action from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens. Message text is returned in plain text, not XML.

Specified by:
getMessageAdminAction in interface MessageServiceAM
Parameters:
pAppShortName - Application Short name
pMessageName - Message name
pTokens - Replacement Tokens
Returns:
Formatted message admin action text

getMessageCause

public java.lang.String getMessageCause(java.lang.String pAppShortName,
                                        java.lang.String pMessageName,
                                        java.util.Map<java.lang.String,java.lang.Object> pTokens)
Get the message cause from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens. Message text is returned in plain text, not XML.

Specified by:
getMessageCause in interface MessageServiceAM
Parameters:
pAppShortName - Application Short name
pMessageName - Message name
pTokens - Replacement Tokens
Returns:
Formatted message cause text

getMessageEncodedText

public java.lang.String getMessageEncodedText(java.lang.String pAppShortName,
                                              java.lang.String pMessageName,
                                              java.util.Map<java.lang.String,java.lang.Object> pTokens)
Get the message encoded text from fnd message store based on the application name, and message name and return the formatted message text using the supplied replacement tokens. Message text is returned in plain text, not XML.

Specified by:
getMessageEncodedText in interface MessageServiceAM
Parameters:
pAppShortName - Application Short name
pMessageName - Message name
pTokens - Replacement Tokens
Returns:
Formatted message encoded text

getMessage

public MessageVOImpl getMessage()
Container's getter for Message.


getTokenValue

public TokenValueVOImpl getTokenValue()
Container's getter for TokenValue.


getMessageToken

public MessageTokenVOImpl getMessageToken()
Container's getter for MessageToken.


getMessageVOToMessageToken

public oracle.jbo.server.ViewLinkImpl getMessageVOToMessageToken()
Container's getter for MessageVOToMessageToken.


getApplication

public ApplicationPVOImpl getApplication()
Container's getter for Application.

Returns:
Application

getLookupServiceAM1

public oracle.jbo.server.ApplicationModuleImpl getLookupServiceAM1()
Container's getter for LookupServiceAM1.

Returns:
LookupServiceAM1

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-03

Copyright © 2012 Oracle. All Rights Reserved.