JMSModule (Oracle® Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

java.lang.Object
- oracle.fmwplatform.envspec.model.blueprint.jms.JMSModule

```
public class JMSModule
extends Object
```
A JMSModule is group of JMS resources (Queues, Topics, Connection Factories, etc.).

Since:

12.2.2.0

Constructor Summary

Constructors
Constructor and Description

JMSModule()

Constructors
Constructor and Description
`JMSModule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addConnectionFactory(ConnectionFactory connectionFactory)` Add a ConnectionFactory.
`boolean`	`addDestinationKey(DestinationKey destinationKey)` Add a DestinationKey.
`boolean`	`addDistributedQueue(DistributedQueue distributedQueue)` Add a new DistributedQueue.
`boolean`	`addDistributedTopic(DistributedTopic distributedTopic)` Add a DistributedTopic.
`boolean`	`addForeignServer(ForeignServer foreignServer)` Add a ForeignServer.
`boolean`	`addQueue(Queue queue)` Add a Queue.
`boolean`	`addQuota(Quota quota)` Add a Quota.
`boolean`	`addSAFErrorHandling(SAFErrorHandling safErrorHandling)` Add a SAFErrorHandling.
`boolean`	`addSAFImportedDestination(SAFImportedDestination safImportedDestination)` Add a SAFImportedDestination.
`boolean`	`addSAFRemoteContext(SAFRemoteContext safErrorHandling)` Add a SAFRemoteContext.
`boolean`	`addTemplate(JMSTemplate template)` Add a JMSTemplate.
`boolean`	`addTopic(Topic topic)` Add a Topic.
`boolean`	`addUniformDistributedQueue(UniformDistributedQueue uniformDistributedQueue)` Add a UniformDistributedQueue.
`boolean`	`addUniformDistributedTopic(UniformDistributedTopic uniformDistributedTopic)` Add a UniformDistributedTopic.
`List<ConnectionFactory>`	`getConnectionFactories()` Get the list of ConnectionFactory objects.
`ConnectionFactory`	`getConnectionFactory(String id)` Get the specified ConnectionFactory.
`DestinationKey`	`getDestinationKey(String id)` Get the specified DestinationKey.
`List<DestinationKey>`	`getDestinationKeys()` Get the list of DestinationKey objects.
`DistributedQueue`	`getDistributedQueue(String id)` Get the specified DistributedQueue.
`List<DistributedQueue>`	`getDistributedQueues()` Get the list of DistributedQueue objects.
`DistributedTopic`	`getDistributedTopic(String id)` Get the specified DistributedTopic.
`List<DistributedTopic>`	`getDistributedTopics()` Get the list of DistributedTopic objects.
`ForeignServer`	`getForeignServer(String id)` Get the specified ForeignServer.
`List<ForeignServer>`	`getForeignServers()` Get the list of ForeignServer objects.
`String`	`getId()` Get the model ID.
`String`	`getNotes()` Get the notes associated with this JMS module.
`Queue`	`getQueue(String id)` Get the specified Queue.
`List<Queue>`	`getQueues()` Get the list of Queue objects.
`Quota`	`getQuota(String id)` Get the specified Quota.
`List<Quota>`	`getQuotas()` Get the list of Quota objects.
`SAFErrorHandling`	`getSAFErrorHandling(String id)` Get the specified SAFErrorHandling.
`List<SAFErrorHandling>`	`getSAFErrorHandlings()` Get the list of SAFErrorHandling objects.
`SAFImportedDestination`	`getSAFImportedDestination(String id)` Get the specified SAFImportedDestination.
`List<SAFImportedDestination>`	`getSAFImportedDestinations()` Get the lift of SAFImportedDestination objects.
`SAFRemoteContext`	`getSAFRemoteContext(String id)` Get the specified SAFRemoteContext.
`List<SAFRemoteContext>`	`getSAFRemoteContexts()` Get the lift of SAFRemoteContext objects.
`JMSTemplate`	`getTemplate(String id)` Get the specified JMSTemplate.
`List<JMSTemplate>`	`getTemplates()` Get the list of JMSTemplate objects.
`Topic`	`getTopic(String id)` Get the specified Topic.
`List<Topic>`	`getTopics()` Get the list of Topic objects.
`UniformDistributedQueue`	`getUniformDistributedQueue(String id)` Get the specified UniformDistributedQueue.
`List<UniformDistributedQueue>`	`getUniformDistributedQueues()` Get the list of UniformDistributedQueue objects.
`UniformDistributedTopic`	`getUniformDistributedTopic(String id)` Get the specified UniformDistributedTopic.
`List<UniformDistributedTopic>`	`getUniformDistributedTopics()` Get the list of UniformDistributedTopic objects.
`Integer`	`getVersion()` Get the version of the JMS module.
`JMSModule`	`setConnectionFactories(List<ConnectionFactory> connectionFactories)` Set the list of ConnectionFactory objects.
`JMSModule`	`setDestinationKeys(List<DestinationKey> destinationKeys)` Set the list of DestinationKey objects.
`JMSModule`	`setDistributedQueues(List<DistributedQueue> distributedQueues)` Set the list of DistributedQueue objects.
`JMSModule`	`setDistributedTopics(List<DistributedTopic> distributedTopics)` Set the list of DistributedTopic objects.
`JMSModule`	`setForeignServers(List<ForeignServer> foreignServers)` Set the list of ForeignServer objects.
`JMSModule`	`setId(String id)` Set the model ID.
`JMSModule`	`setNotes(String notes)` Set the notes to associate with the JMS module.
`JMSModule`	`setQueues(List<Queue> queues)` Set the list of Queue objects.
`JMSModule`	`setQuotas(List<Quota> quotas)` Set the list of Quota objects.
`JMSModule`	`setSAFErrorHandlings(List<SAFErrorHandling> SAFErrorHandlings)` Set the list of SAFErrorHandling objects.
`JMSModule`	`setSAFImportedDestinations(List<SAFImportedDestination> safImportedDestinations)` Set the lift of SAFImportedDestination objects.
`JMSModule`	`setSAFRemoteContexts(List<SAFRemoteContext> safRemoteContexts)` Set the lift of SAFRemoteContext objects.
`JMSModule`	`setTemplates(List<JMSTemplate> templates)` Set the list of JMSTemplate objects.
`JMSModule`	`setTopics(List<Topic> topics)` Set the list of Topic objects.
`JMSModule`	`setUniformDistributedQueues(List<UniformDistributedQueue> uniformDistributedQueues)` Set the list of UniformDistributedQueue objects.
`JMSModule`	`setUniformDistributedTopics(List<UniformDistributedTopic> uniformDistributedTopics)` Set the list of UniformDistributedTopic objects.
`JMSModule`	`setVersion(Integer version)` Set the version of the JMS module.
`String`	`toCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toJsonCompactString()` Returns a compact string representation of the object in JSON format.
`String`	`toJsonString()` Returns a string representation of the object in JSON format.
`String`	`toString()` Returns a string representation of the object in XML format.
`String`	`toXmlCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toXmlString()` Returns a string representation of the object in XML format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JMSModule
```
public JMSModule()
```
- Method Detail
  - getId
```
public String getId()
```
    Get the model ID.
    
    Returns:
    
    the model ID
  - setId
```
public JMSModule setId(String id)
```
    Set the model ID.
    
    Parameters:
    
    id - the new model ID
    
    Returns:
    
    the current JMSModule object
  - getNotes
```
public String getNotes()
```
    Get the notes associated with this JMS module.
    
    Returns:
    
    the notes
  - setNotes
```
public JMSModule setNotes(String notes)
```
    Set the notes to associate with the JMS module.
    
    Parameters:
    
    notes - the new notes
    
    Returns:
    
    the current JMSModule object
  - getVersion
```
public Integer getVersion()
```
    Get the version of the JMS module.
    
    Returns:
    
    the version
  - setVersion
```
public JMSModule setVersion(Integer version)
```
    Set the version of the JMS module.
    
    Parameters:
    
    version - the new version
    
    Returns:
    
    the current JMSModule object
  - addConnectionFactory
```
public boolean addConnectionFactory(ConnectionFactory connectionFactory)
```
    Add a ConnectionFactory.
    
    Parameters:
    
    connectionFactory - the ConnectionFactory to add
    
    Returns:
    
    whether or not the ConnectionFactory was added
  - getConnectionFactory
```
public ConnectionFactory getConnectionFactory(String id)
```
    Get the specified ConnectionFactory.
    
    Parameters:
    
    id - the id of the ConnectionFactory to get
    
    Returns:
    
    the specified ConnectionFactory or null, if not found
  - getConnectionFactories
```
public List<ConnectionFactory> getConnectionFactories()
```
    Get the list of ConnectionFactory objects.
    
    Returns:
    
    the list of ConnectionFactory objects
  - setConnectionFactories
```
public JMSModule setConnectionFactories(List<ConnectionFactory> connectionFactories)
```
    Set the list of ConnectionFactory objects.
    
    Parameters:
    
    connectionFactories - the new list
    
    Returns:
    
    the current JMSModule object
  - addDestinationKey
```
public boolean addDestinationKey(DestinationKey destinationKey)
```
    Add a DestinationKey.
    
    Parameters:
    
    destinationKey - the DestinationKey to add
    
    Returns:
    
    whether or not the DestinationKey was added
  - getDestinationKey
```
public DestinationKey getDestinationKey(String id)
```
    Get the specified DestinationKey.
    
    Parameters:
    
    id - the id of the DestinationKey to get
    
    Returns:
    
    the specified DestinationKey or null, if not found
  - getDestinationKeys
```
public List<DestinationKey> getDestinationKeys()
```
    Get the list of DestinationKey objects.
    
    Returns:
    
    the list of DestinationKey objects
  - setDestinationKeys
```
public JMSModule setDestinationKeys(List<DestinationKey> destinationKeys)
```
    Set the list of DestinationKey objects.
    
    Parameters:
    
    destinationKeys - the new list
    
    Returns:
    
    the current JMSModule object
  - addDistributedQueue
```
public boolean addDistributedQueue(DistributedQueue distributedQueue)
```
    Add a new DistributedQueue.
    
    Parameters:
    
    distributedQueue - the DistributedQueue to add
    
    Returns:
    
    whether or not the DistributedQueue was added
  - getDistributedQueue
```
public DistributedQueue getDistributedQueue(String id)
```
    Get the specified DistributedQueue.
    
    Parameters:
    
    id - the id of the DistributedQueue to get
    
    Returns:
    
    the specified DistributedQueue or null, if it was not found
  - getDistributedQueues
```
public List<DistributedQueue> getDistributedQueues()
```
    Get the list of DistributedQueue objects.
    
    Returns:
    
    the list of DistributedQueue objects
  - setDistributedQueues
```
public JMSModule setDistributedQueues(List<DistributedQueue> distributedQueues)
```
    Set the list of DistributedQueue objects.
    
    Parameters:
    
    distributedQueues - the new list
    
    Returns:
    
    the current JMSModule object
  - addDistributedTopic
```
public boolean addDistributedTopic(DistributedTopic distributedTopic)
```
    Add a DistributedTopic.
    
    Parameters:
    
    distributedTopic - the DistributedTopic to add
    
    Returns:
    
    whether or not the DistributedTopic was added
  - getDistributedTopic
```
public DistributedTopic getDistributedTopic(String id)
```
    Get the specified DistributedTopic.
    
    Parameters:
    
    id - the id of the DistributedTopic to get
    
    Returns:
    
    the specified DistributedTopic or null, if it was not found
  - getDistributedTopics
```
public List<DistributedTopic> getDistributedTopics()
```
    Get the list of DistributedTopic objects.
    
    Returns:
    
    the list of DistributedTopic objects
  - setDistributedTopics
```
public JMSModule setDistributedTopics(List<DistributedTopic> distributedTopics)
```
    Set the list of DistributedTopic objects.
    
    Parameters:
    
    distributedTopics - the new list
    
    Returns:
    
    the current JMSModule object
  - addForeignServer
```
public boolean addForeignServer(ForeignServer foreignServer)
```
    Add a ForeignServer.
    
    Parameters:
    
    foreignServer - the ForeignServer to add
    
    Returns:
    
    whether or not the ForeignServer was added
  - getForeignServer
```
public ForeignServer getForeignServer(String id)
```
    Get the specified ForeignServer.
    
    Parameters:
    
    id - the id of the ForeignServer to get
    
    Returns:
    
    the specified ForeignServer or null, if it was not found
  - getForeignServers
```
public List<ForeignServer> getForeignServers()
```
    Get the list of ForeignServer objects.
    
    Returns:
    
    the list of ForeignServer objects
  - setForeignServers
```
public JMSModule setForeignServers(List<ForeignServer> foreignServers)
```
    Set the list of ForeignServer objects.
    
    Parameters:
    
    foreignServers - the new list
    
    Returns:
    
    the current JMSModule object
  - addQueue
```
public boolean addQueue(Queue queue)
```
    Add a Queue.
    
    Parameters:
    
    queue - the Queue to add
    
    Returns:
    
    whether or not the Queue was added
  - getQueue
```
public Queue getQueue(String id)
```
    Get the specified Queue.
    
    Parameters:
    
    id - the id of the Queue to get
    
    Returns:
    
    the specified Queue or null, if it was not found
  - getQueues
```
public List<Queue> getQueues()
```
    Get the list of Queue objects.
    
    Returns:
    
    the list of Queue objects
  - setQueues
```
public JMSModule setQueues(List<Queue> queues)
```
    Set the list of Queue objects.
    
    Parameters:
    
    queues - the new list
    
    Returns:
    
    the current JMSModule object
  - addQuota
```
public boolean addQuota(Quota quota)
```
    Add a Quota.
    
    Parameters:
    
    quota - the Quota to add
    
    Returns:
    
    whether or not the Quota was added
  - getQuota
```
public Quota getQuota(String id)
```
    Get the specified Quota.
    
    Parameters:
    
    id - the id of the Quota to get
    
    Returns:
    
    the specified Quota or null, if it was not found
  - getQuotas
```
public List<Quota> getQuotas()
```
    Get the list of Quota objects.
    
    Returns:
    
    the list of Quota objects
  - setQuotas
```
public JMSModule setQuotas(List<Quota> quotas)
```
    Set the list of Quota objects.
    
    Parameters:
    
    quotas - the new list
    
    Returns:
    
    the current JMSModule object
  - addSAFErrorHandling
```
public boolean addSAFErrorHandling(SAFErrorHandling safErrorHandling)
```
    Add a SAFErrorHandling.
    
    Parameters:
    
    safErrorHandling - the SAFErrorHandling to add
    
    Returns:
    
    whether or not the SAFErrorHandling was added
  - getSAFErrorHandling
```
public SAFErrorHandling getSAFErrorHandling(String id)
```
    Get the specified SAFErrorHandling.
    
    Parameters:
    
    id - the id of the SAFErrorHandling to get
    
    Returns:
    
    the specified SAFErrorHandling or null, if it was not found
  - getSAFErrorHandlings
```
public List<SAFErrorHandling> getSAFErrorHandlings()
```
    Get the list of SAFErrorHandling objects.
    
    Returns:
    
    the list of SAFErrorHandling objects
  - setSAFErrorHandlings
```
public JMSModule setSAFErrorHandlings(List<SAFErrorHandling> SAFErrorHandlings)
```
    Set the list of SAFErrorHandling objects.
    
    Parameters:
    
    SAFErrorHandlings - the new list
    
    Returns:
    
    the current JMSModule object
  - addSAFImportedDestination
```
public boolean addSAFImportedDestination(SAFImportedDestination safImportedDestination)
```
    Add a SAFImportedDestination.
    
    Parameters:
    
    safImportedDestination - the SAFImportedDestination to add
    
    Returns:
    
    whether or not the SAFImportedDestination was added
  - getSAFImportedDestination
```
public SAFImportedDestination getSAFImportedDestination(String id)
```
    Get the specified SAFImportedDestination.
    
    Parameters:
    
    id - the id of the SAFImportedDestination to get
    
    Returns:
    
    the specified SAFImportedDestination or null, if it was not found
  - getSAFImportedDestinations
```
public List<SAFImportedDestination> getSAFImportedDestinations()
```
    Get the lift of SAFImportedDestination objects.
    
    Returns:
    
    the lift of SAFImportedDestination objects
  - setSAFImportedDestinations
```
public JMSModule setSAFImportedDestinations(List<SAFImportedDestination> safImportedDestinations)
```
    Set the lift of SAFImportedDestination objects.
    
    Parameters:
    
    safImportedDestinations - the new list
    
    Returns:
    
    the current JMSModule object
  - addSAFRemoteContext
```
public boolean addSAFRemoteContext(SAFRemoteContext safErrorHandling)
```
    Add a SAFRemoteContext.
    
    Parameters:
    
    safErrorHandling - the SAFRemoteContext to add
    
    Returns:
    
    whether or not the SAFRemoteContextwas added
  - getSAFRemoteContext
```
public SAFRemoteContext getSAFRemoteContext(String id)
```
    Get the specified SAFRemoteContext.
    
    Parameters:
    
    id - the id of the SAFRemoteContext to get
    
    Returns:
    
    the specified SAFRemoteContext or null, if it was not found
  - getSAFRemoteContexts
```
public List<SAFRemoteContext> getSAFRemoteContexts()
```
    Get the lift of SAFRemoteContext objects.
    
    Returns:
    
    the lift of SAFRemoteContext objects
  - setSAFRemoteContexts
```
public JMSModule setSAFRemoteContexts(List<SAFRemoteContext> safRemoteContexts)
```
    Set the lift of SAFRemoteContext objects.
    
    Parameters:
    
    safRemoteContexts - the new list
    
    Returns:
    
    the current JMSModule object
  - addTemplate
```
public boolean addTemplate(JMSTemplate template)
```
    Add a JMSTemplate.
    
    Parameters:
    
    template - the JMSTemplate to add
    
    Returns:
    
    whether or not the JMSTemplate was added
  - getTemplate
```
public JMSTemplate getTemplate(String id)
```
    Get the specified JMSTemplate.
    
    Parameters:
    
    id - the id of the JMSTemplate to get
    
    Returns:
    
    the specified JMSTemplate or null, if it was not found
  - getTemplates
```
public List<JMSTemplate> getTemplates()
```
    Get the list of JMSTemplate objects.
    
    Returns:
    
    the list of JMSTemplate objects
  - setTemplates
```
public JMSModule setTemplates(List<JMSTemplate> templates)
```
    Set the list of JMSTemplate objects.
    
    Parameters:
    
    templates - the new list
    
    Returns:
    
    the current JMSModule object
  - addTopic
```
public boolean addTopic(Topic topic)
```
    Add a Topic.
    
    Parameters:
    
    topic - the Topic to add
    
    Returns:
    
    whether or not the Topic was added
  - getTopic
```
public Topic getTopic(String id)
```
    Get the specified Topic.
    
    Parameters:
    
    id - the id of the Topic to add
    
    Returns:
    
    the specified Topic or null, if it was not found
  - getTopics
```
public List<Topic> getTopics()
```
    Get the list of Topic objects.
    
    Returns:
    
    the list of Topic objects
  - setTopics
```
public JMSModule setTopics(List<Topic> topics)
```
    Set the list of Topic objects.
    
    Parameters:
    
    topics - the new list
    
    Returns:
    
    the current JMSModule object
  - addUniformDistributedQueue
```
public boolean addUniformDistributedQueue(UniformDistributedQueue uniformDistributedQueue)
```
    Add a UniformDistributedQueue.
    
    Parameters:
    
    uniformDistributedQueue - the UniformDistributedQueue to add
    
    Returns:
    
    whther or not the UniformDistributedQueue was added
  - getUniformDistributedQueue
```
public UniformDistributedQueue getUniformDistributedQueue(String id)
```
    Get the specified UniformDistributedQueue.
    
    Parameters:
    
    id - the id of the UniformDistributedQueue to get
    
    Returns:
    
    the specified UniformDistributedQueue or null, if it was not found
  - getUniformDistributedQueues
```
public List<UniformDistributedQueue> getUniformDistributedQueues()
```
    Get the list of UniformDistributedQueue objects.
    
    Returns:
    
    the list of UniformDistributedQueue objects
  - setUniformDistributedQueues
```
public JMSModule setUniformDistributedQueues(List<UniformDistributedQueue> uniformDistributedQueues)
```
    Set the list of UniformDistributedQueue objects.
    
    Parameters:
    
    uniformDistributedQueues - the new list
    
    Returns:
    
    the current JMSModule object
  - addUniformDistributedTopic
```
public boolean addUniformDistributedTopic(UniformDistributedTopic uniformDistributedTopic)
```
    Add a UniformDistributedTopic.
    
    Parameters:
    
    uniformDistributedTopic - the UniformDistributedTopic to add
    
    Returns:
    
    whether or not the UniformDistributedTopic was added
  - getUniformDistributedTopic
```
public UniformDistributedTopic getUniformDistributedTopic(String id)
```
    Get the specified UniformDistributedTopic.
    
    Parameters:
    
    id - the id of the UniformDistributedTopic to get
    
    Returns:
    
    the specified UniformDistributedTopic or null, if it was not found
  - getUniformDistributedTopics
```
public List<UniformDistributedTopic> getUniformDistributedTopics()
```
    Get the list of UniformDistributedTopic objects.
    
    Returns:
    
    the list of UniformDistributedTopic objects
  - setUniformDistributedTopics
```
public JMSModule setUniformDistributedTopics(List<UniformDistributedTopic> uniformDistributedTopics)
```
    Set the list of UniformDistributedTopic objects.
    
    Parameters:
    
    uniformDistributedTopics - the new list
    
    Returns:
    
    the current JMSModule object
  - toXmlCompactString
```
public String toXmlCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toXmlString
```
public String toXmlString()
```
    Returns a string representation of the object in XML format.
    
    Returns:
    
    a string representation of the object in XML format
  - toJsonCompactString
```
public String toJsonCompactString()
```
    Returns a compact string representation of the object in JSON format.
    
    Returns:
    
    a compact string representation of the object in JSON format
  - toJsonString
```
public String toJsonString()
```
    Returns a string representation of the object in JSON format.
    
    Returns:
    
    a string representation of the object in JSON format
  - toCompactString
```
public String toCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toString
```
public String toString()
```
    Returns a string representation of the object in XML format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object in XML format

Class JMSModule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JMSModule

Method Detail

getId

setId

getNotes

setNotes

getVersion

setVersion

addConnectionFactory

getConnectionFactory

getConnectionFactories

setConnectionFactories

addDestinationKey

getDestinationKey

getDestinationKeys

setDestinationKeys

addDistributedQueue

getDistributedQueue

getDistributedQueues

setDistributedQueues

addDistributedTopic

getDistributedTopic

getDistributedTopics

setDistributedTopics

addForeignServer

getForeignServer

getForeignServers

setForeignServers

addQueue

getQueue

getQueues

setQueues

addQuota

getQuota

getQuotas

setQuotas

addSAFErrorHandling

getSAFErrorHandling

getSAFErrorHandlings

setSAFErrorHandlings

addSAFImportedDestination

getSAFImportedDestination

getSAFImportedDestinations

setSAFImportedDestinations

addSAFRemoteContext

getSAFRemoteContext

getSAFRemoteContexts

setSAFRemoteContexts

addTemplate

getTemplate

getTemplates

setTemplates

addTopic

getTopic

getTopics

setTopics

addUniformDistributedQueue

getUniformDistributedQueue

getUniformDistributedQueues

setUniformDistributedQueues

addUniformDistributedTopic

getUniformDistributedTopic

getUniformDistributedTopics

setUniformDistributedTopics

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString