|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface EntityBeanType<T>
This interface defines the contract for the entity-beanType xsd type
Original Documentation:
The entity-beanType declares an entity bean. The declaration
consists of:
- an optional description
- an optional display name
- an optional icon element that contains a small and a large
icon file name
- a unique name assigned to the enterprise bean
in the deployment descriptor
- an optional mapped-name element that can be used to provide
vendor-specific deployment information such as the physical
jndi-name of the entity bean's remote home interface. This
element is not required to be supported by all implementations.
Any use of this element is non-portable.
- the names of the entity bean's remote home
and remote interfaces, if any
- the names of the entity bean's local home and local
interfaces, if any
- the entity bean's implementation class
- the optional entity bean's persistence management type. If
this element is not specified it is defaulted to Container.
- the entity bean's primary key class name
- an indication of the entity bean's reentrancy
- an optional specification of the
entity bean's cmp-version
- an optional specification of the entity bean's
abstract schema name
- an optional list of container-managed fields
- an optional specification of the primary key
field
- an optional declaration of the bean's environment
entries
- an optional declaration of the bean's EJB
references
- an optional declaration of the bean's local
EJB references
- an optional declaration of the bean's web
service references
- an optional declaration of the security role
references
- an optional declaration of the security identity
to be used for the execution of the bean's methods
- an optional declaration of the bean's
resource manager connection factory references
- an optional declaration of the bean's
resource environment references
- an optional declaration of the bean's message
destination references
- an optional set of query declarations
for finder and select methods for an entity
bean with cmp-version 2.x.
The optional abstract-schema-name element must be specified
for an entity bean with container-managed persistence and
cmp-version 2.x.
The optional primkey-field may be present in the descriptor
if the entity's persistence-type is Container.
The optional cmp-version element may be present in the
descriptor if the entity's persistence-type is Container. If
the persistence-type is Container and the cmp-version
element is not specified, its value defaults to 2.x.
The optional home and remote elements must be specified if
the entity bean cmp-version is 1.x.
The optional home and remote elements must be specified if
the entity bean has a remote home and remote interface.
The optional local-home and local elements must be specified
if the entity bean has a local home and local interface.
Either both the local-home and the local elements or both
the home and the remote elements must be specified.
The optional query elements must be present if the
persistence-type is Container and the cmp-version is 2.x and
query methods other than findByPrimaryKey have been defined
for the entity bean.
The other elements that are optional are "optional" in the
sense that they are omitted if the lists represented by them
are empty.
At least one cmp-field element must be present in the
descriptor if the entity's persistence-type is Container and
the cmp-version is 1.x, and none must not be present if the
entity's persistence-type is Bean.
| Method Summary | |
|---|---|
CmpFieldType<EntityBeanType<T>> |
cmpField()
Returns the cmp-field element |
DataSourceType<EntityBeanType<T>> |
dataSource()
Returns the data-source element |
EjbLocalRefType<EntityBeanType<T>> |
ejbLocalRef()
Returns the ejb-local-ref element |
EjbRefType<EntityBeanType<T>> |
ejbRef()
Returns the ejb-ref element |
EnvEntryType<EntityBeanType<T>> |
envEntry()
Returns the env-entry element |
java.lang.String |
getAbstractSchemaName()
Returns the abstract-schema-name element |
java.util.List<CmpFieldType<EntityBeanType<T>>> |
getCmpFieldList()
Returns all cmp-field elements |
CmpVersionType |
getCmpVersion()
Returns the cmp-version element |
java.lang.String |
getCmpVersionAsString()
Returns the cmp-version element |
java.util.List<DataSourceType<EntityBeanType<T>>> |
getDataSourceList()
Returns all data-source elements |
java.util.List<java.lang.String> |
getDescriptionList()
Returns all description elements |
java.util.List<java.lang.String> |
getDisplayNameList()
Returns all display-name elements |
java.lang.String |
getEjbClass()
Returns the ejb-class element |
java.util.List<EjbLocalRefType<EntityBeanType<T>>> |
getEjbLocalRefList()
Returns all ejb-local-ref elements |
java.lang.String |
getEjbName()
Returns the ejb-name element |
java.util.List<EjbRefType<EntityBeanType<T>>> |
getEjbRefList()
Returns all ejb-ref elements |
java.util.List<EnvEntryType<EntityBeanType<T>>> |
getEnvEntryList()
Returns all env-entry elements |
java.lang.String |
getHome()
Returns the home element |
java.util.List<IconType<EntityBeanType<T>>> |
getIconList()
Returns all icon elements |
java.lang.String |
getLocal()
Returns the local element |
java.lang.String |
getLocalHome()
Returns the local-home element |
java.lang.String |
getMappedName()
Returns the mapped-name element |
java.util.List<MessageDestinationRefType<EntityBeanType<T>>> |
getMessageDestinationRefList()
Returns all message-destination-ref elements |
java.util.List<PersistenceContextRefType<EntityBeanType<T>>> |
getPersistenceContextRefList()
Returns all persistence-context-ref elements |
PersistenceTypeType |
getPersistenceType()
Returns the persistence-type element |
java.lang.String |
getPersistenceTypeAsString()
Returns the persistence-type element |
java.util.List<PersistenceUnitRefType<EntityBeanType<T>>> |
getPersistenceUnitRefList()
Returns all persistence-unit-ref elements |
java.util.List<LifecycleCallbackType<EntityBeanType<T>>> |
getPostConstructList()
Returns all post-construct elements |
java.util.List<LifecycleCallbackType<EntityBeanType<T>>> |
getPreDestroyList()
Returns all pre-destroy elements |
java.lang.String |
getPrimKeyClass()
Returns the prim-key-class element |
java.lang.String |
getPrimkeyField()
Returns the primkey-field element |
java.util.List<QueryType<EntityBeanType<T>>> |
getQueryList()
Returns all query elements |
java.lang.String |
getRemote()
Returns the remote element |
java.util.List<ResourceEnvRefType<EntityBeanType<T>>> |
getResourceEnvRefList()
Returns all resource-env-ref elements |
java.util.List<ResourceRefType<EntityBeanType<T>>> |
getResourceRefList()
Returns all resource-ref elements |
java.util.List<SecurityRoleRefType<EntityBeanType<T>>> |
getSecurityRoleRefList()
Returns all security-role-ref elements |
IconType<EntityBeanType<T>> |
icon()
Returns the icon element |
java.lang.Boolean |
isReentrant()
Returns the reentrant element |
MessageDestinationRefType<EntityBeanType<T>> |
messageDestinationRef()
Returns the message-destination-ref element |
PersistenceContextRefType<EntityBeanType<T>> |
persistenceContextRef()
Returns the persistence-context-ref element |
PersistenceUnitRefType<EntityBeanType<T>> |
persistenceUnitRef()
Returns the persistence-unit-ref element |
LifecycleCallbackType<EntityBeanType<T>> |
postConstruct()
Returns the post-construct element |
LifecycleCallbackType<EntityBeanType<T>> |
preDestroy()
Returns the pre-destroy element |
QueryType<EntityBeanType<T>> |
query()
Returns the query element |
EntityBeanType<T> |
removeAbstractSchemaName()
Removes the abstract-schema-name element |
EntityBeanType<T> |
removeAllCmpField()
Removes all cmp-field elements |
EntityBeanType<T> |
removeAllDataSource()
Removes all data-source elements |
EntityBeanType<T> |
removeAllDescription()
Removes the description element |
EntityBeanType<T> |
removeAllDisplayName()
Removes the display-name element |
EntityBeanType<T> |
removeAllEjbLocalRef()
Removes all ejb-local-ref elements |
EntityBeanType<T> |
removeAllEjbRef()
Removes all ejb-ref elements |
EntityBeanType<T> |
removeAllEnvEntry()
Removes all env-entry elements |
EntityBeanType<T> |
removeAllIcon()
Removes all icon elements |
EntityBeanType<T> |
removeAllMessageDestinationRef()
Removes all message-destination-ref elements |
EntityBeanType<T> |
removeAllPersistenceContextRef()
Removes all persistence-context-ref elements |
EntityBeanType<T> |
removeAllPersistenceUnitRef()
Removes all persistence-unit-ref elements |
EntityBeanType<T> |
removeAllPostConstruct()
Removes all post-construct elements |
EntityBeanType<T> |
removeAllPreDestroy()
Removes all pre-destroy elements |
EntityBeanType<T> |
removeAllQuery()
Removes all query elements |
EntityBeanType<T> |
removeAllResourceEnvRef()
Removes all resource-env-ref elements |
EntityBeanType<T> |
removeAllResourceRef()
Removes all resource-ref elements |
EntityBeanType<T> |
removeAllSecurityRoleRef()
Removes all security-role-ref elements |
EntityBeanType<T> |
removeEjbClass()
Removes the ejb-class element |
EntityBeanType<T> |
removeEjbName()
Removes the ejb-name element |
EntityBeanType<T> |
removeHome()
Removes the home element |
EntityBeanType<T> |
removeLocal()
Removes the local element |
EntityBeanType<T> |
removeLocalHome()
Removes the local-home element |
EntityBeanType<T> |
removeMappedName()
Removes the mapped-name element |
EntityBeanType<T> |
removePrimKeyClass()
Removes the prim-key-class element |
EntityBeanType<T> |
removePrimkeyField()
Removes the primkey-field element |
EntityBeanType<T> |
removeReentrant()
Removes the reentrant element |
EntityBeanType<T> |
removeRemote()
Removes the remote element |
EntityBeanType<T> |
removeSecurityIdentity()
Removes the security-identity element |
ResourceEnvRefType<EntityBeanType<T>> |
resourceEnvRef()
Returns the resource-env-ref element |
ResourceRefType<EntityBeanType<T>> |
resourceRef()
Returns the resource-ref element |
SecurityIdentityType<EntityBeanType<T>> |
securityIdentity()
If not already created, a new security-identity element will be created and returned. |
SecurityRoleRefType<EntityBeanType<T>> |
securityRoleRef()
Returns the security-role-ref element |
EntityBeanType<T> |
setAbstractSchemaName(java.lang.String abstractSchemaName)
If not already created, a new abstract-schema-name element with the given value will be created. |
EntityBeanType<T> |
setCmpVersion(CmpVersionType cmpVersion)
If not already created, a new cmp-version element with the given value will be created. |
EntityBeanType<T> |
setCmpVersion(java.lang.String cmpVersion)
If not already created, a new cmp-version element with the given value will be created. |
EntityBeanType<T> |
setDescription(java.lang.String description)
Creates a new description element |
EntityBeanType<T> |
setDescriptionList(java.lang.String... values)
Creates for all String objects representing description elements,
a new description element |
EntityBeanType<T> |
setDisplayName(java.lang.String displayName)
Creates a new display-name element |
EntityBeanType<T> |
setDisplayNameList(java.lang.String... values)
Creates for all String objects representing display-name elements,
a new display-name element |
EntityBeanType<T> |
setEjbClass(java.lang.String ejbClass)
If not already created, a new ejb-class element with the given value will be created. |
EntityBeanType<T> |
setEjbName(java.lang.String ejbName)
If not already created, a new ejb-name element with the given value will be created. |
EntityBeanType<T> |
setHome(java.lang.String home)
If not already created, a new home element with the given value will be created. |
EntityBeanType<T> |
setLocal(java.lang.String local)
If not already created, a new local element with the given value will be created. |
EntityBeanType<T> |
setLocalHome(java.lang.String localHome)
If not already created, a new local-home element with the given value will be created. |
EntityBeanType<T> |
setMappedName(java.lang.String mappedName)
If not already created, a new mapped-name element with the given value will be created. |
EntityBeanType<T> |
setPersistenceType(PersistenceTypeType persistenceType)
If not already created, a new persistence-type element with the given value will be created. |
EntityBeanType<T> |
setPersistenceType(java.lang.String persistenceType)
If not already created, a new persistence-type element with the given value will be created. |
EntityBeanType<T> |
setPrimKeyClass(java.lang.String primKeyClass)
If not already created, a new prim-key-class element with the given value will be created. |
EntityBeanType<T> |
setPrimkeyField(java.lang.String primkeyField)
If not already created, a new primkey-field element with the given value will be created. |
EntityBeanType<T> |
setReentrant(java.lang.Boolean reentrant)
If not already created, a new reentrant element with the given value will be created. |
EntityBeanType<T> |
setRemote(java.lang.String remote)
If not already created, a new remote element with the given value will be created. |
| Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child |
|---|
up |
| Method Detail |
|---|
EntityBeanType<T> setDescription(java.lang.String description)
description element
EntityBeanTypeEntityBeanType<T> setDescriptionList(java.lang.String... values)
description elements,
a new description element
list - of description objects
EntityBeanTypeEntityBeanType<T> removeAllDescription()
description element
EntityBeanTypejava.util.List<java.lang.String> getDescriptionList()
description elements
descriptionEntityBeanType<T> setDisplayName(java.lang.String displayName)
display-name element
EntityBeanTypeEntityBeanType<T> setDisplayNameList(java.lang.String... values)
display-name elements,
a new display-name element
list - of display-name objects
EntityBeanTypeEntityBeanType<T> removeAllDisplayName()
display-name element
EntityBeanTypejava.util.List<java.lang.String> getDisplayNameList()
display-name elements
display-nameEntityBeanType<T> removeAllIcon()
icon elements
EntityBeanTypeIconType<EntityBeanType<T>> icon()
icon element
iconjava.util.List<IconType<EntityBeanType<T>>> getIconList()
icon elements
iconEntityBeanType<T> removeAllEnvEntry()
env-entry elements
EntityBeanTypeEnvEntryType<EntityBeanType<T>> envEntry()
env-entry element
env-entryjava.util.List<EnvEntryType<EntityBeanType<T>>> getEnvEntryList()
env-entry elements
env-entryEntityBeanType<T> removeAllEjbRef()
ejb-ref elements
EntityBeanTypeEjbRefType<EntityBeanType<T>> ejbRef()
ejb-ref element
ejb-refjava.util.List<EjbRefType<EntityBeanType<T>>> getEjbRefList()
ejb-ref elements
ejb-refEntityBeanType<T> removeAllEjbLocalRef()
ejb-local-ref elements
EntityBeanTypeEjbLocalRefType<EntityBeanType<T>> ejbLocalRef()
ejb-local-ref element
ejb-local-refjava.util.List<EjbLocalRefType<EntityBeanType<T>>> getEjbLocalRefList()
ejb-local-ref elements
ejb-local-refEntityBeanType<T> removeAllResourceRef()
resource-ref elements
EntityBeanTypeResourceRefType<EntityBeanType<T>> resourceRef()
resource-ref element
resource-refjava.util.List<ResourceRefType<EntityBeanType<T>>> getResourceRefList()
resource-ref elements
resource-refEntityBeanType<T> removeAllResourceEnvRef()
resource-env-ref elements
EntityBeanTypeResourceEnvRefType<EntityBeanType<T>> resourceEnvRef()
resource-env-ref element
resource-env-refjava.util.List<ResourceEnvRefType<EntityBeanType<T>>> getResourceEnvRefList()
resource-env-ref elements
resource-env-refEntityBeanType<T> removeAllMessageDestinationRef()
message-destination-ref elements
EntityBeanTypeMessageDestinationRefType<EntityBeanType<T>> messageDestinationRef()
message-destination-ref element
message-destination-refjava.util.List<MessageDestinationRefType<EntityBeanType<T>>> getMessageDestinationRefList()
message-destination-ref elements
message-destination-refEntityBeanType<T> removeAllPersistenceContextRef()
persistence-context-ref elements
EntityBeanTypePersistenceContextRefType<EntityBeanType<T>> persistenceContextRef()
persistence-context-ref element
persistence-context-refjava.util.List<PersistenceContextRefType<EntityBeanType<T>>> getPersistenceContextRefList()
persistence-context-ref elements
persistence-context-refEntityBeanType<T> removeAllPersistenceUnitRef()
persistence-unit-ref elements
EntityBeanTypePersistenceUnitRefType<EntityBeanType<T>> persistenceUnitRef()
persistence-unit-ref element
persistence-unit-refjava.util.List<PersistenceUnitRefType<EntityBeanType<T>>> getPersistenceUnitRefList()
persistence-unit-ref elements
persistence-unit-refEntityBeanType<T> removeAllPostConstruct()
post-construct elements
EntityBeanTypeLifecycleCallbackType<EntityBeanType<T>> postConstruct()
post-construct element
post-constructjava.util.List<LifecycleCallbackType<EntityBeanType<T>>> getPostConstructList()
post-construct elements
post-constructEntityBeanType<T> removeAllPreDestroy()
pre-destroy elements
EntityBeanTypeLifecycleCallbackType<EntityBeanType<T>> preDestroy()
pre-destroy element
pre-destroyjava.util.List<LifecycleCallbackType<EntityBeanType<T>>> getPreDestroyList()
pre-destroy elements
pre-destroyEntityBeanType<T> removeAllDataSource()
data-source elements
EntityBeanTypeDataSourceType<EntityBeanType<T>> dataSource()
data-source element
data-sourcejava.util.List<DataSourceType<EntityBeanType<T>>> getDataSourceList()
data-source elements
data-sourceEntityBeanType<T> setEjbName(java.lang.String ejbName)
ejb-name element with the given value will be created.
Otherwise, the existing ejb-name element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> removeEjbName()
ejb-name element
EntityBeanTypejava.lang.String getEjbName()
ejb-name element
ejb-nameEntityBeanType<T> setMappedName(java.lang.String mappedName)
mapped-name element with the given value will be created.
Otherwise, the existing mapped-name element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> removeMappedName()
mapped-name element
EntityBeanTypejava.lang.String getMappedName()
mapped-name element
mapped-nameEntityBeanType<T> setHome(java.lang.String home)
home element with the given value will be created.
Otherwise, the existing home element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> removeHome()
home element
EntityBeanTypejava.lang.String getHome()
home element
homeEntityBeanType<T> setRemote(java.lang.String remote)
remote element with the given value will be created.
Otherwise, the existing remote element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> removeRemote()
remote element
EntityBeanTypejava.lang.String getRemote()
remote element
remoteEntityBeanType<T> setLocalHome(java.lang.String localHome)
local-home element with the given value will be created.
Otherwise, the existing local-home element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> removeLocalHome()
local-home element
EntityBeanTypejava.lang.String getLocalHome()
local-home element
local-homeEntityBeanType<T> setLocal(java.lang.String local)
local element with the given value will be created.
Otherwise, the existing local element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> removeLocal()
local element
EntityBeanTypejava.lang.String getLocal()
local element
localEntityBeanType<T> setEjbClass(java.lang.String ejbClass)
ejb-class element with the given value will be created.
Otherwise, the existing ejb-class element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> removeEjbClass()
ejb-class element
EntityBeanTypejava.lang.String getEjbClass()
ejb-class element
ejb-classEntityBeanType<T> setPersistenceType(PersistenceTypeType persistenceType)
persistence-type element with the given value will be created.
Otherwise, the existing persistence-type element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> setPersistenceType(java.lang.String persistenceType)
persistence-type element with the given value will be created.
Otherwise, the existing persistence-type element will be updated with the given value.
EntityBeanTypePersistenceTypeType getPersistenceType()
persistence-type element
persistence-typejava.lang.String getPersistenceTypeAsString()
persistence-type element
persistence-typeEntityBeanType<T> setPrimKeyClass(java.lang.String primKeyClass)
prim-key-class element with the given value will be created.
Otherwise, the existing prim-key-class element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> removePrimKeyClass()
prim-key-class element
EntityBeanTypejava.lang.String getPrimKeyClass()
prim-key-class element
prim-key-classEntityBeanType<T> setReentrant(java.lang.Boolean reentrant)
reentrant element with the given value will be created.
Otherwise, the existing reentrant element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> removeReentrant()
reentrant element
EntityBeanTypejava.lang.Boolean isReentrant()
reentrant element
reentrantEntityBeanType<T> setCmpVersion(CmpVersionType cmpVersion)
cmp-version element with the given value will be created.
Otherwise, the existing cmp-version element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> setCmpVersion(java.lang.String cmpVersion)
cmp-version element with the given value will be created.
Otherwise, the existing cmp-version element will be updated with the given value.
EntityBeanTypeCmpVersionType getCmpVersion()
cmp-version element
cmp-versionjava.lang.String getCmpVersionAsString()
cmp-version element
cmp-versionEntityBeanType<T> setAbstractSchemaName(java.lang.String abstractSchemaName)
abstract-schema-name element with the given value will be created.
Otherwise, the existing abstract-schema-name element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> removeAbstractSchemaName()
abstract-schema-name element
EntityBeanTypejava.lang.String getAbstractSchemaName()
abstract-schema-name element
abstract-schema-nameEntityBeanType<T> removeAllCmpField()
cmp-field elements
EntityBeanTypeCmpFieldType<EntityBeanType<T>> cmpField()
cmp-field element
cmp-fieldjava.util.List<CmpFieldType<EntityBeanType<T>>> getCmpFieldList()
cmp-field elements
cmp-fieldEntityBeanType<T> setPrimkeyField(java.lang.String primkeyField)
primkey-field element with the given value will be created.
Otherwise, the existing primkey-field element will be updated with the given value.
EntityBeanTypeEntityBeanType<T> removePrimkeyField()
primkey-field element
EntityBeanTypejava.lang.String getPrimkeyField()
primkey-field element
primkey-fieldEntityBeanType<T> removeAllSecurityRoleRef()
security-role-ref elements
EntityBeanTypeSecurityRoleRefType<EntityBeanType<T>> securityRoleRef()
security-role-ref element
security-role-refjava.util.List<SecurityRoleRefType<EntityBeanType<T>>> getSecurityRoleRefList()
security-role-ref elements
security-role-refEntityBeanType<T> removeSecurityIdentity()
security-identity element
EntityBeanTypeSecurityIdentityType<EntityBeanType<T>> securityIdentity()
security-identity element will be created and returned.
Otherwise, the existing security-identity element will be returned.
security-identityEntityBeanType<T> removeAllQuery()
query elements
EntityBeanTypeQueryType<EntityBeanType<T>> query()
query element
queryjava.util.List<QueryType<EntityBeanType<T>>> getQueryList()
query elements
query
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||