Skip to main content
summaryrefslogtreecommitdiffstats
blob: 81ed650f64c2bc85b72a549d368b62631d95418e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*******************************************************************************
 * 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.ejb;

import org.eclipse.emf.common.util.EList;
import org.eclipse.jem.java.Field;
import org.eclipse.jem.java.JavaHelpers;
import org.eclipse.jst.j2ee.common.J2EEEAttribute;
/**
 * Describes a container-managed field. The field element includes an optional description of the field, and the name of the field.
 * @generated
 * @since 1.0 */
public interface CMPAttribute extends J2EEEAttribute {

	/**
	 * @deprecated - With EJB 2.0, assuming a Java field is no longer safe.
	 * 		Use getType() and getName() to get the most common field info.
	 *		Or use getEjbClass() to get additional Java info.
	 *@return the Field value
	 */

	Field getField() ;
	
	/**
	 * The name of the get method corresponding to this attrribute
	 * @return the String value
	 */
	String getGetterName();
	/**
	 * Return the type of this attribute in its original form (i.e., unwrapped if
	 * the type has been wrapped).
	 * @return JavaHelpers value
	 */
	public JavaHelpers getOriginatingType() ;
	
	/**
	 * The name of the set method corresponding to this attrribute
	 * @return the String value
	 */
	String getSetterName();
	
	/**
	 * Returns the Java Type of the attribute
	 * @return the JavaHelpers
	 */
	JavaHelpers getType() ;
	
	/**
	 * Returns true if the attribute is a CMR field
	 * @return boolean value
	 */
	boolean isCMRField() ;
	
	/**
	 * Returns true if the attribute is the key field of the bean
	 * @return boolean value
	 */
	boolean isKey() ;
	/**
	 * Returns true if this field is a primkey-field in the deployment descriptor.
	 * @return boolean value
	 */
	public boolean isPrimKeyField();
	
	/**
	 * Sets the originating Java type
	 * @param newOriginatingType the JavaHelpers
	 */
	public void setOriginatingType(JavaHelpers newOriginatingType) ;
	
	/**
	 * @generated This field/method will be replaced during code generation 
	 * @return The value of the Description attribute
	 * The description is used by the ejb-jar file producer to provide text describing 
	 * the cmr field.
	 * 
	 * The description 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 list of dependents.
	 */
	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);

	/**
	 * 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.ejb.EjbPackage#getCMPAttribute_Descriptions()
	 * @model type="org.eclipse.jst.j2ee.common.Description" containment="true"
	 * @generated
	 */
	EList getDescriptions();

	/**
	 * Return true if a targetAttribute exists.
	 * @return boolean value
	 */
	boolean isDerived();
	
	/**
	 * Sets the attribute as a derived attribute
	 * @param aBoolean the boolean value
	 */
	void setDerived(boolean aBoolean);
	
}






Back to the top