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

E22562-01

oracle.apps.fnd.applcore.dt.messages
Class AppsMessageBundleWrapper

java.lang.Object
  extended by oracle.ide.resourcebundle.NodeResourceBundle
      extended by oracle.apps.fnd.applcore.dt.messages.AppsMessageBundleWrapper
All Implemented Interfaces:
java.io.Closeable, java.util.EventListener, TextBufferListener, ResourceBundleWrapper

public final class AppsMessageBundleWrapper
extends NodeResourceBundle

This class is the implementation of the Applications Resource Bundle. It extends the NodeResourceBundle class.


Nested Class Summary
 
Nested classes/interfaces inherited from class oracle.ide.resourcebundle.NodeResourceBundle
NodeResourceBundle.OperationType, NodeResourceBundle.SearchType
 
Nested classes/interfaces inherited from interface oracle.javatools.resourcebundle.ResourceBundleWrapper
ResourceBundleWrapper.KeyInfo
 
Field Summary
 
Fields inherited from interface oracle.javatools.buffer.TextBufferListener
EOL_TYPE_ATTRIBUTE, MODIFIED_ATTRIBUTE, READ_ONLY_ATTRIBUTE, RELOAD_END_ATTRIBUTE, RELOAD_START_ATTRIBUTE
 
Constructor Summary
AppsMessageBundleWrapper()
          Constructor of this class.
 
Method Summary
 java.lang.String addEntry(java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata)
          This method is not required to be implemented for this bundle.
 boolean addEntry(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata)
          This method is not required to be implemented for this bundle.
 void addResourceBundleListener(ResourceBundleListener listener)
          This method is used to add a listener for this bundle.
 boolean allowsCreateResource()
          Returns if this bundle allows the creation of new resources.
 boolean allowsQueryType(ResourceBundleConstants.QueryTypes types)
          Returns if a particular query type is allowed by this bundle.
 void beginEditorListening(Editor editor)
          This method is not required to be implemented for this bundle.
 boolean deleteEntry(java.lang.String key)
          This method is not required to be implemented for this bundle.
 void endEditorListening(Editor editor)
          This method is not required to be implemented for this bundle.
 java.util.Set<java.lang.String> findKeysByMetaData(java.util.Map<java.lang.String,java.lang.String> metadata)
          This method is not required to be implemented for this bundle.
 java.util.Set<java.lang.String> findKeysByText(java.lang.String text)
          This method is not required to be implemented for this bundle.
 java.util.Set<java.lang.String> findKeysLikeKey(java.lang.String key)
          This method returns the set of all the keys that metches the given key.
 java.util.Set<java.lang.String> findKeysLikeText(java.lang.String text)
          This method is not required to be implemented for this bundle.
static ResourceBundleWrapper getInstance()
          This static method returns a singleton instance of this class.
 ResourceBundleKeyGenerator getKeyGenerator()
          This method is not required to be implemented for this bundle.
 java.util.Map<java.lang.String,java.lang.String> getMetadata(java.lang.String key)
          This method returns the metadata for a given key.
 ResourceBundleConstants.SearchMode getSearchMode()
          Return the mode of serach to be used in the UI for this bundle.
 java.lang.String getString(java.lang.String key)
          Returns the value for the current key.
 java.util.Set<java.lang.String> keySet()
          This method returns all the keys available in this bundle.
 void removeResourceBundleListener(ResourceBundleListener listener)
          This method is remove a listener for this bundle.
 void setKeyGenerator(ResourceBundleKeyGenerator generator)
          This method is not required to be implemented for this bundle.
 java.lang.String toString()
          Returns the display name for this bundle.
 boolean updateEntry(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata)
          This method is not required to be implemented for this bundle.
 
Methods inherited from class oracle.ide.resourcebundle.NodeResourceBundle
addEntryNoDialog, attributeUpdate, close, createBaseDocument, delete, fireKeyAdded, fireKeyChanged, fireKeyRemoved, fireMetadataChanged, fireTextChanged, fireUnknownChange, getBundleId, getMessageText, getResourceBundleNode, getTooltipText, getType, insertUpdate, isHeadless, preUpdateValidation, removeUpdate, sendEditorChanges, setBundleId, setResourceBundleNode, setType, showReadOnlyDialog, showWarningDialog, updateEntryNoDialog
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AppsMessageBundleWrapper

public AppsMessageBundleWrapper()
Constructor of this class. Required to be public by IDE DT.

Method Detail

getInstance

public static ResourceBundleWrapper getInstance()
This static method returns a singleton instance of this class.

Returns:
An instance of this class.

getString

public java.lang.String getString(java.lang.String key)
Returns the value for the current key. This metod checks for the value in the temporary storage. If it is not found, then it retrieves the value from the database.

Parameters:
key - The message key
Returns:
The message string for the key.

addEntry

public boolean addEntry(java.lang.String key,
                        java.lang.String text,
                        java.util.Map<java.lang.String,java.lang.String> metadata)
This method is not required to be implemented for this bundle.

Parameters:
key - DOCUMENT ME
text - DOCUMENT ME
metadata - DOCUMENT ME
Returns:
DOCUMENT ME

addEntry

public java.lang.String addEntry(java.lang.String text,
                                 java.util.Map<java.lang.String,java.lang.String> metadata)
This method is not required to be implemented for this bundle.

Specified by:
addEntry in interface ResourceBundleWrapper
Overrides:
addEntry in class NodeResourceBundle
Parameters:
text - DOCUMENT ME
metadata - DOCUMENT ME
Returns:
DOCUMENT ME

deleteEntry

public boolean deleteEntry(java.lang.String key)
This method is not required to be implemented for this bundle.

Parameters:
key - DOCUMENT ME
Returns:
DOCUMENT ME

updateEntry

public boolean updateEntry(java.lang.String key,
                           java.lang.String text,
                           java.util.Map<java.lang.String,java.lang.String> metadata)
This method is not required to be implemented for this bundle.

Parameters:
key - DOCUMENT ME
text - DOCUMENT ME
metadata - DOCUMENT ME
Returns:
DOCUMENT ME

findKeysByText

public java.util.Set<java.lang.String> findKeysByText(java.lang.String text)
This method is not required to be implemented for this bundle.

Parameters:
text - DOCUMENT ME
Returns:
DOCUMENT ME

findKeysLikeText

public java.util.Set<java.lang.String> findKeysLikeText(java.lang.String text)
This method is not required to be implemented for this bundle.

Parameters:
text - DOCUMENT ME
Returns:
DOCUMENT ME

findKeysByMetaData

public java.util.Set<java.lang.String> findKeysByMetaData(java.util.Map<java.lang.String,java.lang.String> metadata)
This method is not required to be implemented for this bundle.

Parameters:
metadata - DOCUMENT ME
Returns:
DOCUMENT ME

findKeysLikeKey

public java.util.Set<java.lang.String> findKeysLikeKey(java.lang.String key)
This method returns the set of all the keys that metches the given key.

Parameters:
key - The name of the key used to filter the keys.
Returns:
Set of matching keys.

addResourceBundleListener

public void addResourceBundleListener(ResourceBundleListener listener)
This method is used to add a listener for this bundle.

Specified by:
addResourceBundleListener in interface ResourceBundleWrapper
Overrides:
addResourceBundleListener in class NodeResourceBundle
Parameters:
listener - DOCUMENT ME

removeResourceBundleListener

public void removeResourceBundleListener(ResourceBundleListener listener)
This method is remove a listener for this bundle.

Specified by:
removeResourceBundleListener in interface ResourceBundleWrapper
Overrides:
removeResourceBundleListener in class NodeResourceBundle
Parameters:
listener - DOCUMENT ME

setKeyGenerator

public void setKeyGenerator(ResourceBundleKeyGenerator generator)
This method is not required to be implemented for this bundle.

Specified by:
setKeyGenerator in interface ResourceBundleWrapper
Overrides:
setKeyGenerator in class NodeResourceBundle
Parameters:
generator - DOCUMENT ME

getKeyGenerator

public ResourceBundleKeyGenerator getKeyGenerator()
This method is not required to be implemented for this bundle.

Specified by:
getKeyGenerator in interface ResourceBundleWrapper
Overrides:
getKeyGenerator in class NodeResourceBundle
Returns:
DOCUMENT ME

keySet

public java.util.Set<java.lang.String> keySet()
This method returns all the keys available in this bundle. This method is not required to be implemented for this bundle.

Returns:
Set of all the keys in this bundle.

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata(java.lang.String key)
This method returns the metadata for a given key.

Parameters:
key - The message key
Returns:
Metadata for the given key

beginEditorListening

public void beginEditorListening(Editor editor)
This method is not required to be implemented for this bundle.

Overrides:
beginEditorListening in class NodeResourceBundle
Parameters:
editor - DOCUMENT ME

endEditorListening

public void endEditorListening(Editor editor)
This method is not required to be implemented for this bundle.

Overrides:
endEditorListening in class NodeResourceBundle
Parameters:
editor - DOCUMENT ME

allowsCreateResource

public boolean allowsCreateResource()
Returns if this bundle allows the creation of new resources.

Overrides:
allowsCreateResource in class NodeResourceBundle
Returns:
Return false as it is not required to create a new resource.

getSearchMode

public ResourceBundleConstants.SearchMode getSearchMode()
Return the mode of serach to be used in the UI for this bundle.

Overrides:
getSearchMode in class NodeResourceBundle
Returns:
The search mode for this bundle is ResourceBundleConstants.SearchMode.SEARCH.

allowsQueryType

public boolean allowsQueryType(ResourceBundleConstants.QueryTypes types)
Returns if a particular query type is allowed by this bundle.

Overrides:
allowsQueryType in class NodeResourceBundle
Parameters:
types - The QueryTypes object
Returns:
True only if the type is QueryTypes.KEY.

toString

public java.lang.String toString()
Returns the display name for this bundle.

Overrides:
toString in class NodeResourceBundle
Returns:
Display name of this bundle.

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

E22562-01

Copyright © 2011 Oracle. All Rights Reserved.