org.eclipse.modisco.jee.ejbjar.EjbJar21
Interface EjbJarType


public interface EjbJarType

A representation of the model object 'Ejb Jar Type'. The ejb-jarType defines the root element of the EJB deployment descriptor. It contains - an optional description of the ejb-jar file - an optional display name - an optional icon that contains a small and a large icon file name - mandatory structural information about all included enterprise beans - a descriptor for container managed relationships, if any - an optional application-assembly descriptor - an optional name of an ejb-client-jar file for the ejb-jar.

The following features are supported:

See Also:
EjbJar21Package.getEjbJarType()
Generated:
Model:
extendedMetaData="name='ejb-jarType' kind='elementOnly'"

Method Summary
 AssemblyDescriptorType getAssemblyDescriptor()
          Returns the value of the 'Assembly Descriptor' containment reference.
  getDescription()
          Returns the value of the 'Description' containment reference list.
  getDisplayName()
          Returns the value of the 'Display Name' containment reference list.
 PathType getEjbClientJar()
          Returns the value of the 'Ejb Client Jar' containment reference.
 EnterpriseBeansType getEnterpriseBeans()
          Returns the value of the 'Enterprise Beans' containment reference.
  getIcon()
          Returns the value of the 'Icon' containment reference list.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
 RelationshipsType getRelationships()
          Returns the value of the 'Relationships' containment reference.
 java.math.BigDecimal getVersion()
          Returns the value of the 'Version' attribute.
 boolean isSetVersion()
          Returns whether the value of the 'Version' attribute is set.
 void setAssemblyDescriptor(AssemblyDescriptorType value)
          Sets the value of the 'Assembly Descriptor' containment reference.
 void setEjbClientJar(PathType value)
          Sets the value of the 'Ejb Client Jar' containment reference.
 void setEnterpriseBeans(EnterpriseBeansType value)
          Sets the value of the 'Enterprise Beans' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 void setRelationships(RelationshipsType value)
          Sets the value of the 'Relationships' containment reference.
 void setVersion(java.math.BigDecimal value)
          Sets the value of the 'Version' attribute.
 void unsetVersion()
          Unsets the value of the 'Version' attribute.
 

Method Detail

getDescription

 getDescription()
Returns the value of the 'Description' containment reference list. The list contents are of type DescriptionType.

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

Returns:
the value of the 'Description' containment reference list.
See Also:
EjbJar21Package.getEjbJarType_Description()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='description' namespace='http://java.sun.com/xml/ns/j2ee'"

getDisplayName

 getDisplayName()
Returns the value of the 'Display Name' containment reference list. The list contents are of type DisplayNameType.

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

Returns:
the value of the 'Display Name' containment reference list.
See Also:
EjbJar21Package.getEjbJarType_DisplayName()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='display-name' namespace='http://java.sun.com/xml/ns/j2ee'"

getIcon

 getIcon()
Returns the value of the 'Icon' containment reference list. The list contents are of type IconType.

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

Returns:
the value of the 'Icon' containment reference list.
See Also:
EjbJar21Package.getEjbJarType_Icon()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='icon' namespace='http://java.sun.com/xml/ns/j2ee'"

getEnterpriseBeans

EnterpriseBeansType getEnterpriseBeans()
Returns the value of the 'Enterprise Beans' containment reference.

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

Returns:
the value of the 'Enterprise Beans' containment reference.
See Also:
setEnterpriseBeans(EnterpriseBeansType), EjbJar21Package.getEjbJarType_EnterpriseBeans()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='enterprise-beans' namespace='http://java.sun.com/xml/ns/j2ee'"

setEnterpriseBeans

void setEnterpriseBeans(EnterpriseBeansType value)
Sets the value of the 'Enterprise Beans' containment reference.

Parameters:
value - the new value of the 'Enterprise Beans' containment reference.
See Also:
getEnterpriseBeans()
Generated:

getRelationships

RelationshipsType getRelationships()
Returns the value of the 'Relationships' containment reference.

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

Returns:
the value of the 'Relationships' containment reference.
See Also:
setRelationships(RelationshipsType), EjbJar21Package.getEjbJarType_Relationships()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='relationships' namespace='http://java.sun.com/xml/ns/j2ee'"

setRelationships

void setRelationships(RelationshipsType value)
Sets the value of the 'Relationships' containment reference.

Parameters:
value - the new value of the 'Relationships' containment reference.
See Also:
getRelationships()
Generated:

getAssemblyDescriptor

AssemblyDescriptorType getAssemblyDescriptor()
Returns the value of the 'Assembly Descriptor' containment reference. Providing an assembly-descriptor in the deployment descriptor is optional for the ejb-jar file producer.

Returns:
the value of the 'Assembly Descriptor' containment reference.
See Also:
setAssemblyDescriptor(AssemblyDescriptorType), EjbJar21Package.getEjbJarType_AssemblyDescriptor()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='assembly-descriptor' namespace='http://java.sun.com/xml/ns/j2ee'"

setAssemblyDescriptor

void setAssemblyDescriptor(AssemblyDescriptorType value)
Sets the value of the 'Assembly Descriptor' containment reference.

Parameters:
value - the new value of the 'Assembly Descriptor' containment reference.
See Also:
getAssemblyDescriptor()
Generated:

getEjbClientJar

PathType getEjbClientJar()
Returns the value of the 'Ejb Client Jar' containment reference. employee_service_client.jar ]]>

Returns:
the value of the 'Ejb Client Jar' containment reference.
See Also:
setEjbClientJar(PathType), EjbJar21Package.getEjbJarType_EjbClientJar()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='ejb-client-jar' namespace='http://java.sun.com/xml/ns/j2ee'"

setEjbClientJar

void setEjbClientJar(PathType value)
Sets the value of the 'Ejb Client Jar' containment reference.

Parameters:
value - the new value of the 'Ejb Client Jar' containment reference.
See Also:
getEjbClientJar()
Generated:

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), EjbJar21Package.getEjbJarType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated:

getVersion

java.math.BigDecimal getVersion()
Returns the value of the 'Version' attribute. The default value is "2.1". The version specifies the version of the EJB specification that the instance document must comply with. This information enables deployment tools to validate a particular EJB Deployment Descriptor with respect to a specific version of the EJB schema.

Returns:
the value of the 'Version' attribute.
See Also:
isSetVersion(), unsetVersion(), setVersion(BigDecimal), EjbJar21Package.getEjbJarType_Version()
Generated:
Model:
default="2.1" unsettable="true" dataType="org.eclipse.modisco.jee.ejbjar.EjbJar21.DeweyVersionType" required="true" extendedMetaData="kind='attribute' name='version'"

setVersion

void setVersion(java.math.BigDecimal value)
Sets the value of the 'Version' attribute.

Parameters:
value - the new value of the 'Version' attribute.
See Also:
isSetVersion(), unsetVersion(), getVersion()
Generated:

unsetVersion

void unsetVersion()
Unsets the value of the 'Version' attribute.

See Also:
isSetVersion(), getVersion(), setVersion(BigDecimal)
Generated:

isSetVersion

boolean isSetVersion()
Returns whether the value of the 'Version' attribute is set.

Returns:
whether the value of the 'Version' attribute is set.
See Also:
unsetVersion(), getVersion(), setVersion(BigDecimal)
Generated: