/*******************************************************************************
* Copyright (c) 2007 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jst.javaee.core;
import java.util.List;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Message Destination</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
*
* [
* The message-destinationType specifies a message
* destination. The logical destination described by this
* element is mapped to a physical destination by the Deployer.
*
* The message destination element contains:
*
* - an optional description
* - an optional display-name
* - an optional icon
* - a message destination name which must be unique
* among message destination names within the same
* Deployment File.
* - an optional mapped name
* - an optional lookup name
*
* Example:
*
* <message-destination>
* <message-destination-name>CorporateStocks
* </message-destination-name>
* </message-destination>
*
*
* @since Java EE 5
*
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.jst.javaee.core.MessageDestination#getDescriptions <em>Descriptions</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.MessageDestination#getDisplayNames <em>Display Names</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.MessageDestination#getIcons <em>Icons</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.MessageDestination#getMessageDestinationName <em>Message Destination Name</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.MessageDestination#getMappedName <em>Mapped Name</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.MessageDestination#getLookupName <em>Lookup Name</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.MessageDestination#getId <em>Id</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getMessageDestination()
* @extends JavaEEObject
* @generated
*/
public interface MessageDestination extends JavaEEObject {
/**
* Returns the value of the '<em><b>Descriptions</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.jst.javaee.core.Description}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Descriptions</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Descriptions</em>' containment reference list.
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getMessageDestination_Descriptions()
* @generated
*/
List<Description> getDescriptions();
/**
* Returns the value of the '<em><b>Display Names</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.jst.javaee.core.DisplayName}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Display Names</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Display Names</em>' containment reference list.
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getMessageDestination_DisplayNames()
* @generated
*/
List<DisplayName> getDisplayNames();
/**
* Returns the value of the '<em><b>Icons</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.jst.javaee.core.Icon}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Icons</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Icons</em>' containment reference list.
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getMessageDestination_Icons()
* @generated
*/
List<Icon> getIcons();
/**
* Returns the value of the '<em><b>Message Destination Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
* The message-destination-name element specifies a
* name for a message destination. This name must be
* unique among the names of message destinations
* within the Deployment File.
*
* @since Java EE 5
*
* <!-- end-model-doc -->
* @return the value of the '<em>Message Destination Name</em>' attribute.
* @see #setMessageDestinationName(String)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getMessageDestination_MessageDestinationName()
* @generated
*/
String getMessageDestinationName();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.MessageDestination#getMessageDestinationName <em>Message Destination Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Message Destination Name</em>' attribute.
* @see #getMessageDestinationName()
* @generated
*/
void setMessageDestinationName(String value);
/**
* Returns the value of the '<em><b>Mapped Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
* A product specific name that this message destination
* should be mapped to. Each message-destination-ref
* element that references this message destination will
* define a name in the namespace of the referencing
* component or in one of the other predefined namespaces.
* Many application servers provide a way to map these
* local names to names of resources known to the
* application server. This mapped name is often a global
* JNDI name, but may be a name of any form. Each of the
* local names should be mapped to this same global name.
*
* Application servers are not required to support any
* particular form or type of mapped name, nor the ability
* to use mapped names. The mapped name is
* product-dependent and often installation-dependent. No
* use of a mapped name is portable.
*
* @since Java EE 5
*
* <!-- end-model-doc -->
* @return the value of the '<em>Mapped Name</em>' attribute.
* @see #setMappedName(String)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getMessageDestination_MappedName()
* @generated
*/
String getMappedName();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.MessageDestination#getMappedName <em>Mapped Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Mapped Name</em>' attribute.
* @see #getMappedName()
* @generated
*/
void setMappedName(String value);
/**
* Returns the value of the '<em><b>Lookup Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
* The JNDI name to be looked up to resolve the message destination.
*
* @since Java EE 6
*
* <!-- end-model-doc -->
* @return the value of the '<em>Lookup Name</em>' attribute.
* @see #setLookupName(String)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getMessageDestination_LookupName()
* @generated
*/
String getLookupName();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.MessageDestination#getLookupName <em>Lookup Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Lookup Name</em>' attribute.
* @see #getLookupName()
* @generated
*/
void setLookupName(String value);
/**
* Returns the value of the '<em><b>Id</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Id</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Id</em>' attribute.
* @see #setId(String)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getMessageDestination_Id()
* @generated
*/
String getId();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.MessageDestination#getId <em>Id</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Id</em>' attribute.
* @see #getId()
* @generated
*/
void setId(String value);
} // MessageDestination