org.eclipse.jst.j2ee.ejb
Interface CMPAttribute

All Superinterfaces:
org.eclipse.emf.ecore.EAttribute, org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.ENamedElement, org.eclipse.emf.ecore.EObject, org.eclipse.emf.ecore.EStructuralFeature, org.eclipse.emf.ecore.ETypedElement, J2EEEAttribute, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
CMRField

public interface CMPAttribute
extends J2EEEAttribute

Describes a container-managed field. The field element includes an optional description of the field, and the name of the field.

Since:
1.0

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.emf.ecore.EStructuralFeature
org.eclipse.emf.ecore.EStructuralFeature.Internal, org.eclipse.emf.ecore.EStructuralFeature.Setting
 
Field Summary
 
Fields inherited from interface org.eclipse.emf.ecore.ETypedElement
UNBOUNDED_MULTIPLICITY, UNSPECIFIED_MULTIPLICITY
 
Method Summary
 java.lang.String getDescription()
           
 org.eclipse.emf.common.util.EList getDescriptions()
          Returns the value of the 'Descriptions' containment reference list.
 Field getField()
          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.
 java.lang.String getGetterName()
          The name of the get method corresponding to this attrribute
 JavaHelpers getOriginatingType()
          Return the type of this attribute in its original form (i.e., unwrapped if the type has been wrapped).
 java.lang.String getSetterName()
          The name of the set method corresponding to this attrribute
 JavaHelpers getType()
          Returns the Java Type of the attribute
 boolean isCMRField()
          Returns true if the attribute is a CMR field
 boolean isDerived()
          Return true if a targetAttribute exists.
 boolean isKey()
          Returns true if the attribute is the key field of the bean
 boolean isPrimKeyField()
          Returns true if this field is a primkey-field in the deployment descriptor.
 void setDerived(boolean aBoolean)
          Sets the attribute as a derived attribute
 void setDescription(java.lang.String value)
           
 void setOriginatingType(JavaHelpers newOriginatingType)
          Sets the originating Java type
 
Methods inherited from interface org.eclipse.emf.ecore.EAttribute
getEAttributeType, isID, setID
 
Methods inherited from interface org.eclipse.emf.ecore.EStructuralFeature
getContainerClass, getDefaultValue, getDefaultValueLiteral, getEContainingClass, getFeatureID, isChangeable, isTransient, isUnsettable, isVolatile, setChangeable, setDefaultValue, setDefaultValueLiteral, setTransient, setUnsettable, setVolatile
 
Methods inherited from interface org.eclipse.emf.ecore.ETypedElement
getEGenericType, getEType, getLowerBound, getUpperBound, isMany, isOrdered, isRequired, isUnique, setEGenericType, setEType, setLowerBound, setOrdered, setUnique, setUpperBound
 
Methods inherited from interface org.eclipse.emf.ecore.ENamedElement
getName, setName
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getField

Field getField()
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.

Returns:
the Field value

getGetterName

java.lang.String getGetterName()
The name of the get method corresponding to this attrribute

Returns:
the String value

getOriginatingType

JavaHelpers getOriginatingType()
Return the type of this attribute in its original form (i.e., unwrapped if the type has been wrapped).

Returns:
JavaHelpers value

getSetterName

java.lang.String getSetterName()
The name of the set method corresponding to this attrribute

Returns:
the String value

getType

JavaHelpers getType()
Returns the Java Type of the attribute

Returns:
the JavaHelpers

isCMRField

boolean isCMRField()
Returns true if the attribute is a CMR field

Returns:
boolean value

isKey

boolean isKey()
Returns true if the attribute is the key field of the bean

Returns:
boolean value

isPrimKeyField

boolean isPrimKeyField()
Returns true if this field is a primkey-field in the deployment descriptor.

Returns:
boolean value

setOriginatingType

void setOriginatingType(JavaHelpers newOriginatingType)
Sets the originating Java type

Parameters:
newOriginatingType - the JavaHelpers

getDescription

java.lang.String getDescription()
Returns:
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.

setDescription

void setDescription(java.lang.String value)
Parameters:
value - The new value of the Description attribute

getDescriptions

org.eclipse.emf.common.util.EList getDescriptions()
Returns the value of the 'Descriptions' containment reference list. The list contents are of type Description.

If the meaning of the 'Descriptions' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Descriptions' containment reference list.
See Also:
EjbPackage.getCMPAttribute_Descriptions()

isDerived

boolean isDerived()
Return true if a targetAttribute exists.

Specified by:
isDerived in interface org.eclipse.emf.ecore.EStructuralFeature
Returns:
boolean value

setDerived

void setDerived(boolean aBoolean)
Sets the attribute as a derived attribute

Specified by:
setDerived in interface org.eclipse.emf.ecore.EStructuralFeature
Parameters:
aBoolean - the boolean value