|
||||||||||
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
EntityBeanType
EntityBeanType<T> setDescriptionList(java.lang.String... values)
description
elements,
a new description
element
list
- of description
objects
EntityBeanType
EntityBeanType<T> removeAllDescription()
description
element
EntityBeanType
java.util.List<java.lang.String> getDescriptionList()
description
elements
description
EntityBeanType<T> setDisplayName(java.lang.String displayName)
display-name
element
EntityBeanType
EntityBeanType<T> setDisplayNameList(java.lang.String... values)
display-name
elements,
a new display-name
element
list
- of display-name
objects
EntityBeanType
EntityBeanType<T> removeAllDisplayName()
display-name
element
EntityBeanType
java.util.List<java.lang.String> getDisplayNameList()
display-name
elements
display-name
EntityBeanType<T> removeAllIcon()
icon
elements
EntityBeanType
IconType<EntityBeanType<T>> icon()
icon
element
icon
java.util.List<IconType<EntityBeanType<T>>> getIconList()
icon
elements
icon
EntityBeanType<T> removeAllEnvEntry()
env-entry
elements
EntityBeanType
EnvEntryType<EntityBeanType<T>> envEntry()
env-entry
element
env-entry
java.util.List<EnvEntryType<EntityBeanType<T>>> getEnvEntryList()
env-entry
elements
env-entry
EntityBeanType<T> removeAllEjbRef()
ejb-ref
elements
EntityBeanType
EjbRefType<EntityBeanType<T>> ejbRef()
ejb-ref
element
ejb-ref
java.util.List<EjbRefType<EntityBeanType<T>>> getEjbRefList()
ejb-ref
elements
ejb-ref
EntityBeanType<T> removeAllEjbLocalRef()
ejb-local-ref
elements
EntityBeanType
EjbLocalRefType<EntityBeanType<T>> ejbLocalRef()
ejb-local-ref
element
ejb-local-ref
java.util.List<EjbLocalRefType<EntityBeanType<T>>> getEjbLocalRefList()
ejb-local-ref
elements
ejb-local-ref
EntityBeanType<T> removeAllResourceRef()
resource-ref
elements
EntityBeanType
ResourceRefType<EntityBeanType<T>> resourceRef()
resource-ref
element
resource-ref
java.util.List<ResourceRefType<EntityBeanType<T>>> getResourceRefList()
resource-ref
elements
resource-ref
EntityBeanType<T> removeAllResourceEnvRef()
resource-env-ref
elements
EntityBeanType
ResourceEnvRefType<EntityBeanType<T>> resourceEnvRef()
resource-env-ref
element
resource-env-ref
java.util.List<ResourceEnvRefType<EntityBeanType<T>>> getResourceEnvRefList()
resource-env-ref
elements
resource-env-ref
EntityBeanType<T> removeAllMessageDestinationRef()
message-destination-ref
elements
EntityBeanType
MessageDestinationRefType<EntityBeanType<T>> messageDestinationRef()
message-destination-ref
element
message-destination-ref
java.util.List<MessageDestinationRefType<EntityBeanType<T>>> getMessageDestinationRefList()
message-destination-ref
elements
message-destination-ref
EntityBeanType<T> removeAllPersistenceContextRef()
persistence-context-ref
elements
EntityBeanType
PersistenceContextRefType<EntityBeanType<T>> persistenceContextRef()
persistence-context-ref
element
persistence-context-ref
java.util.List<PersistenceContextRefType<EntityBeanType<T>>> getPersistenceContextRefList()
persistence-context-ref
elements
persistence-context-ref
EntityBeanType<T> removeAllPersistenceUnitRef()
persistence-unit-ref
elements
EntityBeanType
PersistenceUnitRefType<EntityBeanType<T>> persistenceUnitRef()
persistence-unit-ref
element
persistence-unit-ref
java.util.List<PersistenceUnitRefType<EntityBeanType<T>>> getPersistenceUnitRefList()
persistence-unit-ref
elements
persistence-unit-ref
EntityBeanType<T> removeAllPostConstruct()
post-construct
elements
EntityBeanType
LifecycleCallbackType<EntityBeanType<T>> postConstruct()
post-construct
element
post-construct
java.util.List<LifecycleCallbackType<EntityBeanType<T>>> getPostConstructList()
post-construct
elements
post-construct
EntityBeanType<T> removeAllPreDestroy()
pre-destroy
elements
EntityBeanType
LifecycleCallbackType<EntityBeanType<T>> preDestroy()
pre-destroy
element
pre-destroy
java.util.List<LifecycleCallbackType<EntityBeanType<T>>> getPreDestroyList()
pre-destroy
elements
pre-destroy
EntityBeanType<T> removeAllDataSource()
data-source
elements
EntityBeanType
DataSourceType<EntityBeanType<T>> dataSource()
data-source
element
data-source
java.util.List<DataSourceType<EntityBeanType<T>>> getDataSourceList()
data-source
elements
data-source
EntityBeanType<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.
EntityBeanType
EntityBeanType<T> removeEjbName()
ejb-name
element
EntityBeanType
java.lang.String getEjbName()
ejb-name
element
ejb-name
EntityBeanType<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.
EntityBeanType
EntityBeanType<T> removeMappedName()
mapped-name
element
EntityBeanType
java.lang.String getMappedName()
mapped-name
element
mapped-name
EntityBeanType<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.
EntityBeanType
EntityBeanType<T> removeHome()
home
element
EntityBeanType
java.lang.String getHome()
home
element
home
EntityBeanType<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.
EntityBeanType
EntityBeanType<T> removeRemote()
remote
element
EntityBeanType
java.lang.String getRemote()
remote
element
remote
EntityBeanType<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.
EntityBeanType
EntityBeanType<T> removeLocalHome()
local-home
element
EntityBeanType
java.lang.String getLocalHome()
local-home
element
local-home
EntityBeanType<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.
EntityBeanType
EntityBeanType<T> removeLocal()
local
element
EntityBeanType
java.lang.String getLocal()
local
element
local
EntityBeanType<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.
EntityBeanType
EntityBeanType<T> removeEjbClass()
ejb-class
element
EntityBeanType
java.lang.String getEjbClass()
ejb-class
element
ejb-class
EntityBeanType<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.
EntityBeanType
EntityBeanType<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.
EntityBeanType
PersistenceTypeType getPersistenceType()
persistence-type
element
persistence-type
java.lang.String getPersistenceTypeAsString()
persistence-type
element
persistence-type
EntityBeanType<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.
EntityBeanType
EntityBeanType<T> removePrimKeyClass()
prim-key-class
element
EntityBeanType
java.lang.String getPrimKeyClass()
prim-key-class
element
prim-key-class
EntityBeanType<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.
EntityBeanType
EntityBeanType<T> removeReentrant()
reentrant
element
EntityBeanType
java.lang.Boolean isReentrant()
reentrant
element
reentrant
EntityBeanType<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.
EntityBeanType
EntityBeanType<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.
EntityBeanType
CmpVersionType getCmpVersion()
cmp-version
element
cmp-version
java.lang.String getCmpVersionAsString()
cmp-version
element
cmp-version
EntityBeanType<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.
EntityBeanType
EntityBeanType<T> removeAbstractSchemaName()
abstract-schema-name
element
EntityBeanType
java.lang.String getAbstractSchemaName()
abstract-schema-name
element
abstract-schema-name
EntityBeanType<T> removeAllCmpField()
cmp-field
elements
EntityBeanType
CmpFieldType<EntityBeanType<T>> cmpField()
cmp-field
element
cmp-field
java.util.List<CmpFieldType<EntityBeanType<T>>> getCmpFieldList()
cmp-field
elements
cmp-field
EntityBeanType<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.
EntityBeanType
EntityBeanType<T> removePrimkeyField()
primkey-field
element
EntityBeanType
java.lang.String getPrimkeyField()
primkey-field
element
primkey-field
EntityBeanType<T> removeAllSecurityRoleRef()
security-role-ref
elements
EntityBeanType
SecurityRoleRefType<EntityBeanType<T>> securityRoleRef()
security-role-ref
element
security-role-ref
java.util.List<SecurityRoleRefType<EntityBeanType<T>>> getSecurityRoleRefList()
security-role-ref
elements
security-role-ref
EntityBeanType<T> removeSecurityIdentity()
security-identity
element
EntityBeanType
SecurityIdentityType<EntityBeanType<T>> securityIdentity()
security-identity
element will be created and returned.
Otherwise, the existing security-identity
element will be returned.
security-identity
EntityBeanType<T> removeAllQuery()
query
elements
EntityBeanType
QueryType<EntityBeanType<T>> query()
query
element
query
java.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 |