blob: 2d4746ae0d2e7329b1245a2e378654a689c8b630 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2013 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
* https://www.eclipse.org/legal/epl-2.0/
*
* 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>Administered Object Type</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
*
*
* Configuration of an administered object.
*
* @since Java EE 7
*
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.jst.javaee.core.AdministeredObjectType#getDescription <em>Description</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.AdministeredObjectType#getName <em>Name</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.AdministeredObjectType#getInterfaceName <em>Interface Name</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.AdministeredObjectType#getClassName <em>Class Name</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.AdministeredObjectType#getResourceAdapter <em>Resource Adapter</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.AdministeredObjectType#getProperty <em>Property</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.AdministeredObjectType#getId <em>Id</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getAdministeredObjectType()
* @extends JavaEEObject
* @generated
*/
public interface AdministeredObjectType extends JavaEEObject {
/**
* Returns the value of the '<em><b>Description</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
* Description of this administered object.
*
*
* <!-- end-model-doc -->
* @return the value of the '<em>Description</em>' containment reference.
* @see #setDescription(Description)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getAdministeredObjectType_Description()
* @generated
*/
Description getDescription();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.AdministeredObjectType#getDescription <em>Description</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Description</em>' containment reference.
* @see #getDescription()
* @generated
*/
void setDescription(Description value);
/**
* Returns the value of the '<em><b>Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
* The name element specifies the JNDI name of the
* administered object being defined.
*
*
* <!-- end-model-doc -->
* @return the value of the '<em>Name</em>' attribute.
* @see #setName(String)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getAdministeredObjectType_Name()
* @generated
*/
String getName();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.AdministeredObjectType#getName <em>Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Name</em>' attribute.
* @see #getName()
* @generated
*/
void setName(String value);
/**
* Returns the value of the '<em><b>Interface Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
* The administered object's interface type.
*
*
* <!-- end-model-doc -->
* @return the value of the '<em>Interface Name</em>' attribute.
* @see #setInterfaceName(String)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getAdministeredObjectType_InterfaceName()
* @generated
*/
String getInterfaceName();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.AdministeredObjectType#getInterfaceName <em>Interface Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Interface Name</em>' attribute.
* @see #getInterfaceName()
* @generated
*/
void setInterfaceName(String value);
/**
* Returns the value of the '<em><b>Class Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
* The administered object's class name.
*
*
* <!-- end-model-doc -->
* @return the value of the '<em>Class Name</em>' attribute.
* @see #setClassName(String)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getAdministeredObjectType_ClassName()
* @generated
*/
String getClassName();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.AdministeredObjectType#getClassName <em>Class Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Class Name</em>' attribute.
* @see #getClassName()
* @generated
*/
void setClassName(String value);
/**
* Returns the value of the '<em><b>Resource Adapter</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
* Resource adapter name.
*
*
* <!-- end-model-doc -->
* @return the value of the '<em>Resource Adapter</em>' attribute.
* @see #setResourceAdapter(String)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getAdministeredObjectType_ResourceAdapter()
* @generated
*/
String getResourceAdapter();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.AdministeredObjectType#getResourceAdapter <em>Resource Adapter</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Resource Adapter</em>' attribute.
* @see #getResourceAdapter()
* @generated
*/
void setResourceAdapter(String value);
/**
* Returns the value of the '<em><b>Property</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.jst.javaee.core.PropertyType}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
* Property of the administered object property. This may be a
* vendor-specific property.
*
*
* <!-- end-model-doc -->
* @return the value of the '<em>Property</em>' containment reference list.
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getAdministeredObjectType_Property()
* @generated
*/
List<PropertyType> getProperty();
/**
* 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#getAdministeredObjectType_Id()
* @generated
*/
String getId();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.AdministeredObjectType#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);
} // AdministeredObjectType