org.eclipse.jst.j2ee.ejb
Interface ContainerManagedEntity

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, EnterpriseBean, Entity, J2EEEObject, JNDIEnvRefsGroup

public interface ContainerManagedEntity
extends Entity

Since:
1.0

Field Summary
static int DERIVED_FLAG_CHANGE
           
static java.lang.String JAVA_LANG_STRING
          Set to java.lang.String
static java.lang.String UNKNOWN_PRIMARY_KEY
          Set to java.lang.Object
static java.lang.String VERSION_1_X
          Denotes 1.x version of the CMP Bean
static java.lang.String VERSION_2_X
          Denotes 2.x version of the CMP Bean
static java.lang.String WAS_GENERATED_STRING_FIELD
           
static java.lang.String WAS_GENERATED_STRING_KEY
           
 
Method Summary
 CMPAttribute addKeyAttributeName(java.lang.String aName)
          Create a new instance of CMPAttribute with aName and add it to the keyAttributes of the bean
 CMPAttribute addPersistentAttribute(Field aField)
          Add a persistent attribute with the same name as the name for aField.
 CMPAttribute addPersistentAttributeName(java.lang.String aName)
          Create a new instance of CMPAttribute with aName and add it to the persistent attributes
 java.lang.String getAbstractSchemaName()
           
 java.util.List getAllAvailableQueryMethods()
          Return a List, sorted by signature, of all the available Query methods on the remote Home, local Home, or ejbSelect methods on the bean class
 java.util.List getAvailableFindQueryMethods()
          Return a List of all the available Query methods for the Home and Local Home interfaces.
 java.util.List getAvailableSelectQueryMethods()
          Return a List of all the available Query methods for the Bean class.
 EList getCMPAttribute()
          Returns the value of the 'CMP Attribute' reference list.
 int getCMPVersionID()
          This returns the module version id.
 java.util.List getCMRFields()
          Gets the list of CMR Fields
 java.util.List getFilteredFeatures(EJBExtensionFilter aFilter)
          Returns the list of EJBExtensionFilter
 CMPAttribute getKeyAttribute(java.lang.String aName)
          Return the keyAttribute with aName.
 EList getKeyAttributes()
           
 CMPAttribute getPersistentAttribute(java.lang.String aName)
          Return the persistentAttribute with aName.
 EList getPersistentAttributes()
           
 CMPAttribute getPrimaryKeyAttribute()
          Deprecated. - Use getPrimKeyField()
 CMPAttribute getPrimKeyField()
          Returns the value of the 'Prim Key Field' reference
 EList getQueries()
          Returns the value of the 'Queries' containment reference list.
 CommonRelationshipRole getRole(java.lang.String roleName)
          Return a specific CommonRelationshipRole which has a named role that is equal to roleName.
 java.util.List getRoles()
           
 java.lang.String getVersion()
           
 boolean isContainerManagedEntity()
          Returns true when invoked on the instance of this class
 boolean isKeyAttribute(CMPAttribute anAttribute)
          Returns true if anAttribute is a key attribute of the CMP
 boolean isUnknownPrimaryKey()
          Return whether this bean represents an instance of the "unknown primary key" case described in the specification.
 boolean isVersion1_X()
          Returns true if the CMP is of version 1.X
 boolean isVersion2_X()
          Returns true if the CMP is of version 2.X
 java.lang.String[] listPersistentFieldNames()
          Returns the list of Persistent Field Names
 void makePrimKeyFieldProxy()
          Makes the primary Key Field proxy.
 CMPAttribute removePersistentAttribute(Field aField)
          Removes the attribute with the name specified in the aField from the list of persistent attributes
 void setAbstractSchemaName(java.lang.String value)
           
 void setPrimKeyField(CMPAttribute value)
          Sets the value of the 'Prim Key Field' reference
 void setVersion(java.lang.String value)
           
 
Methods inherited from interface org.eclipse.jst.j2ee.ejb.Entity
getPrimaryKey, getPrimaryKeyName, isReentrant, isSetReentrant, setPrimaryKey, setPrimaryKeyName, setReentrant, unsetReentrant
 
Methods inherited from interface org.eclipse.jst.j2ee.ejb.EnterpriseBean
createMethodElements, getAvailableCommonMethodElements, getAvailableCommonMethodElementSignatures, getAvailableHomeMethodElements, getAvailableLocalHomeMethodElements, getAvailableLocalMethodElements, getAvailableRemoteMethodElements, getAvailableUnspecifiedMethodElements, getAvailableUnspecifiedMethodElementSignatures, getEjbClass, getEjbClassName, getEjbJar, getEquivalentEJBLocalRef, getEquivalentEjbRef, getExistingOrAvailableMethodElements, getExistingOrAvailableMethodElements, getHomeInterface, getHomeInterfaceName, getHomeMethodsForDeployment, getLinkedEJBLocalReference, getLinkedEJBReference, getLocalHomeInterface, getLocalHomeInterfaceName, getLocalHomeMethodsForDeployment, getLocalInterface, getLocalInterfaceName, getName, getRemoteInterface, getRemoteInterfaceName, getRemoteMethodsForDeployment, getSecurityIdentity, getSecurityRoleRefs, getVersionID, hasJavaReference, hasLocalClient, hasRemoteClient, isBeanManagedEntity, isEntity, isMessageDriven, isSession, reSyncSecurityRoleRef, setEjbClass, setEjbClassName, setEjbJar, setHomeInterface, setHomeInterfaceName, setLocalHomeInterface, setLocalHomeInterfaceName, setLocalInterface, setLocalInterfaceName, setName, setRemoteInterface, setRemoteInterfaceName, setSecurityIdentity
 
Methods inherited from interface org.eclipse.jst.j2ee.common.JNDIEnvRefsGroup
getEjbLocalRefs, getEjbRefs, getEnvironmentProperties, getMessageDestinationRefs, getResourceEnvRefs, getResourceRefs, getServiceRefs
 
Methods inherited from interface org.eclipse.jst.j2ee.common.CompatibilityDescriptionGroup
getDescription, getDisplayName, getLargeIcon, getSmallIcon, setDescription, setDescriptionGen, setDisplayName, setDisplayNameGen, setLargeIcon, setLargeIconGen, setSmallIcon, setSmallIconGen
 
Methods inherited from interface org.eclipse.jst.j2ee.common.DescriptionGroup
getDescriptions, getDisplayNames, getIcons
 

Field Detail

VERSION_1_X

public static final java.lang.String VERSION_1_X
Denotes 1.x version of the CMP Bean

See Also:
Constant Field Values

VERSION_2_X

public static final java.lang.String VERSION_2_X
Denotes 2.x version of the CMP Bean

See Also:
Constant Field Values

WAS_GENERATED_STRING_KEY

public static final java.lang.String WAS_GENERATED_STRING_KEY
See Also:
Constant Field Values

WAS_GENERATED_STRING_FIELD

public static final java.lang.String WAS_GENERATED_STRING_FIELD
See Also:
Constant Field Values

UNKNOWN_PRIMARY_KEY

public static final java.lang.String UNKNOWN_PRIMARY_KEY
Set to java.lang.Object

See Also:
Constant Field Values

JAVA_LANG_STRING

public static final java.lang.String JAVA_LANG_STRING
Set to java.lang.String

See Also:
Constant Field Values

DERIVED_FLAG_CHANGE

public static final int DERIVED_FLAG_CHANGE
See Also:
Constant Field Values
Method Detail

addKeyAttributeName

public CMPAttribute addKeyAttributeName(java.lang.String aName)
Create a new instance of CMPAttribute with aName and add it to the keyAttributes of the bean

Parameters:
aName - the name of the key attribute
Returns:
CMPAttribute

addPersistentAttribute

public CMPAttribute addPersistentAttribute(Field aField)
Add a persistent attribute with the same name as the name for aField.

Parameters:
aField - a reference of type Field
Returns:
CMPAttribute

addPersistentAttributeName

public CMPAttribute addPersistentAttributeName(java.lang.String aName)
Create a new instance of CMPAttribute with aName and add it to the persistent attributes

Parameters:
aName - the name of the persistent attribute
Returns:
CMPAttribute

getKeyAttribute

public CMPAttribute getKeyAttribute(java.lang.String aName)
Return the keyAttribute with aName. Creation date: (8/8/2000 9:25:27 PM)

Parameters:
aName - java.lang.String
Returns:
EStructuralFeature

getPersistentAttribute

public CMPAttribute getPersistentAttribute(java.lang.String aName)
Return the persistentAttribute with aName. Creation date: (8/8/2000 9:25:27 PM)

Parameters:
aName - java.lang.String
Returns:
EStructuralFeature

getPrimaryKeyAttribute

public CMPAttribute getPrimaryKeyAttribute()
Deprecated. - Use getPrimKeyField()

If a primary key exists, return the persistent attribute; the primary key is defined as one and only one key attribute, whose type is the same as the key class

Returns:
a reference to the CMPAttribute

isContainerManagedEntity

public boolean isContainerManagedEntity()
Returns true when invoked on the instance of this class

Specified by:
isContainerManagedEntity in interface Entity
Returns:
boolean value

isVersion1_X

public boolean isVersion1_X()
Returns true if the CMP is of version 1.X

Specified by:
isVersion1_X in interface EnterpriseBean
Returns:
boolean value
See Also:
J2EEVersionConstants

isVersion2_X

public boolean isVersion2_X()
Returns true if the CMP is of version 2.X

Specified by:
isVersion2_X in interface EnterpriseBean
Returns:
boolean value
See Also:
J2EEVersionConstants

isKeyAttribute

public boolean isKeyAttribute(CMPAttribute anAttribute)
Returns true if anAttribute is a key attribute of the CMP

Parameters:
anAttribute - a attribute of the CMP of type CMPAttribute
Returns:
boolean value

isUnknownPrimaryKey

public boolean isUnknownPrimaryKey()
Return whether this bean represents an instance of the "unknown primary key" case described in the specification. This is identified by the primary key class being specified as "java.lang.Object". In order to deploy an unknown primary key bean, we must substitute a real key, and add a corresponding field.

Returns:
boolean value

listPersistentFieldNames

public java.lang.String[] listPersistentFieldNames()
Returns the list of Persistent Field Names

Returns:
an String array of names

removePersistentAttribute

public CMPAttribute removePersistentAttribute(Field aField)
Removes the attribute with the name specified in the aField from the list of persistent attributes

Parameters:
aField - the Field reference
Returns:
CMPAttribute reference

getVersion

public java.lang.String getVersion()
Returns:
The value of the Version attribute Specifies the version of an entity bean with container-managed persistence.

getCMPVersionID

public int getCMPVersionID()
                    throws java.lang.IllegalStateException
This returns the module version id. Compare with J2EEVersionConstants to determine module level

Returns:
the version of CMP represented in int type
Throws:
java.lang.IllegalStateException - throws this exception when an error is encountered in getting version of the CMP

setVersion

public void setVersion(java.lang.String value)
Parameters:
value - The new value of the Version attribute

getAbstractSchemaName

public java.lang.String getAbstractSchemaName()
Returns:
The value of the AbstractSchemaName attribute The abstract-schema-name element specifies the name of the abstract schema type of an entity bean with cmp-version 2.x. It is used in EJB QL queries. For example, the abstract-schema-name for an entity bean whose local interface is com.acme.commerce.Order might be Order.

setAbstractSchemaName

public void setAbstractSchemaName(java.lang.String value)
Parameters:
value - The new value of the AbstractSchemaName attribute

getPersistentAttributes

public EList getPersistentAttributes()
Returns:
The list of PersistentAttributes references

getKeyAttributes

public EList getKeyAttributes()
Returns:
The list of KeyAttributes references

getQueries

public EList getQueries()
Returns the value of the 'Queries' containment reference list. The list contents are of type Query. It is bidirectional and its opposite is 'Entity'.

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

Returns:
the value of the 'Queries' containment reference list.
See Also:
EjbPackage.getContainerManagedEntity_Queries(), Query.getEntity()

getCMPAttribute

public EList getCMPAttribute()
Returns the value of the 'CMP Attribute' reference list. The list contents are of type CMPAttribute.

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

Returns:
the value of the 'CMP Attribute' reference list.
See Also:
EjbPackage.getContainerManagedEntity_CMPAttribute()

getPrimKeyField

public CMPAttribute getPrimKeyField()
Returns the value of the 'Prim Key Field' reference.

If the meaning of the 'Prim Key Field' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Prim Key Field' reference.
See Also:
setPrimKeyField(CMPAttribute), EjbPackage.getContainerManagedEntity_PrimKeyField()

setPrimKeyField

public void setPrimKeyField(CMPAttribute value)
Sets the value of the 'Prim Key Field' reference.

Parameters:
value - the new value of the 'Prim Key Field' reference.
See Also:
getPrimKeyField()

getAvailableFindQueryMethods

public java.util.List getAvailableFindQueryMethods()
Return a List of all the available Query methods for the Home and Local Home interfaces.

Returns:
List of Find Query Methods

getAvailableSelectQueryMethods

public java.util.List getAvailableSelectQueryMethods()
Return a List of all the available Query methods for the Bean class.

Returns:
List of Select Query Methods

getAllAvailableQueryMethods

public java.util.List getAllAvailableQueryMethods()
Return a List, sorted by signature, of all the available Query methods on the remote Home, local Home, or ejbSelect methods on the bean class

Returns:
List of Query methods

getFilteredFeatures

public java.util.List getFilteredFeatures(EJBExtensionFilter aFilter)
Returns the list of EJBExtensionFilter

Parameters:
aFilter - a reference of type EJBExtensionFilter
Returns:
List of filtered features

makePrimKeyFieldProxy

public void makePrimKeyFieldProxy()
Makes the primary Key Field proxy.


getCMRFields

public java.util.List getCMRFields()
Gets the list of CMR Fields

Returns:
The list of all CMR fields for this bean.

getRoles

public java.util.List getRoles()
Returns:
The list of all roles where this bean is the source.

getRole

public CommonRelationshipRole getRole(java.lang.String roleName)
Return a specific CommonRelationshipRole which has a named role that is equal to roleName.

Parameters:
roleName - the role name
Returns:
a reference to CommonRelationshipRole instance
See Also:
CommonRelationshipRole