| /******************************************************************************* |
| * Copyright (c) 2001, 2006 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.j2ee.common; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| /** |
| * The env-entry element contains the declaration of an application client's environment entries. The declaration consists of an optional description, the name of the environment entry, and an optional value. |
| * @generated |
| * @since 1.0 */ |
| public interface EnvEntry extends J2EEEObject { |
| /** |
| * @generated This field/method will be replaced during code generation |
| * @return The value of the Description attribute |
| * The description element is used by the ejb-jar file producer to provide text |
| * describing the parent element. The description element should include any |
| * information that the ejb-jar file producer wants to provide to the consumer of |
| * the ejb-jar file (i.e. to the Deployer). Typically, the tools used by the |
| * ejb-jar file consumer will display the description when processing the parent |
| * element. |
| */ |
| String getDescription(); |
| |
| /** |
| * @generated This field/method will be replaced during code generation |
| * @param value The new value of the Description attribute |
| */ |
| void setDescription(String value); |
| |
| /** |
| * @generated This field/method will be replaced during code generation |
| * @return The value of the Name attribute |
| * The env-entry-name element contains the name of an application client's |
| * environment entry. |
| */ |
| String getName(); |
| |
| /** |
| * @generated This field/method will be replaced during code generation |
| * @param value The new value of the Name attribute |
| */ |
| void setName(String value); |
| |
| /** |
| * @generated This field/method will be replaced during code generation |
| * @return The value of the Value attribute |
| * The env-entry-value element contains the value of an application client's |
| * environment entry. The value must be a String that is valid for the constructor |
| * of the specified type that takes a single String parameter. |
| * Used in: env-entry |
| * Example: |
| * <env-entry-value>//datasources//MyDatabase<//env-entry-value> |
| */ |
| String getValue(); |
| |
| /** |
| * @generated This field/method will be replaced during code generation |
| * @param value The new value of the Value attribute |
| */ |
| void setValue(String value); |
| |
| /** |
| * @generated This field/method will be replaced during code generation |
| * @return The value of the Type attribute |
| * The env-entry-type element contains the fully-qualified Java type of the |
| * environment entry value that is expected by the application client's code. The |
| * following are the legal values of env-entry-type: java.lang.Bool-ean, |
| * java.lang.String, java.lang.Integer, java.lang.Double, java.lang.Byte, |
| * java.lang.Short, java.lang.Long, and java.lang.Float. |
| * Example: <env-entry-type>java.lang.Boolean<//env-entry-type> |
| */ |
| EnvEntryType getType(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.jst.j2ee.common.EnvEntry#getType <em>Type</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Type</em>' attribute. |
| * @see org.eclipse.jst.j2ee.common.EnvEntryType |
| * @see #isSetType() |
| * @see #unsetType() |
| * @see #getType() |
| * @generated |
| */ |
| void setType(EnvEntryType value); |
| |
| /** |
| * Unsets the value of the '{@link org.eclipse.jst.j2ee.common.EnvEntry#getType <em>Type</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @see #isSetType() |
| * @see #getType() |
| * @see #setType(EnvEntryType) |
| * @generated |
| */ |
| void unsetType(); |
| |
| /** |
| * Returns whether the value of the '{@link org.eclipse.jst.j2ee.common.EnvEntry#getType <em>Type</em>}' attribute is set. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @return whether the value of the '<em>Type</em>' attribute is set. |
| * @see #unsetType() |
| * @see #getType() |
| * @see #setType(EnvEntryType) |
| * @generated |
| */ |
| boolean isSetType(); |
| |
| /** |
| * Returns the value of the '<em><b>Descriptions</b></em>' containment reference list. |
| * The list contents are of type {@link org.eclipse.jst.j2ee.common.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 --> |
| * <!-- begin-model-doc --> |
| * @version J2EE1.4 |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Descriptions</em>' containment reference list. |
| * @see org.eclipse.jst.j2ee.common.CommonPackage#getEnvEntry_Descriptions() |
| * @model type="org.eclipse.jst.j2ee.common.Description" containment="true" |
| * @generated |
| */ |
| EList getDescriptions(); |
| |
| } |
| |
| |
| |
| |
| |