oracle.toplink.tools.ejbjar
Class Description

java.lang.Object
oracle.toplink.tools.ejbjar.DomObject
oracle.toplink.tools.ejbjar.Description

All Implemented Interfaces:

EjbJarConstants

Direct Known Subclasses:

ContainerTransaction, EjbJar, EnterpriseObject, ExcludeList, MethodPermission, NameAndDescription, Query, Relationship, RelationshipRole, RelationshipRoleSource, Relationships, SecurityIdentity

public abstract class Description

extends DomObject

Since a number of elements have optional description sub-elements this abstract class can be subclassed to inherit the description element support.

Field Summary

Fields inherited from interface oracle.toplink.tools.ejbjar.EjbJarConstants

ABSTRACT_SCHEMA_NAME, ACKNOWLEDGE_MODE, APPLICATION_AUTH, ASSEMBLY_DESCRIPTOR, AUTO_ACKNOWLEDGE, BEAN_MANAGED, BOOLEAN_TYPE, BYTE_TYPE, CASCADE_DELETE, CMP_FIELD, CMP_VERSION, CMP_VERSION_1, CMP_VERSION_2, CMR_FIELD, CMR_FIELD_NAME, CMR_FIELD_TYPE, COLLECTION_TYPE, CONTAINER_AUTH, CONTAINER_MANAGED, CONTAINER_TRANSACTION, DESCRIPTION, DESTINATION_TYPE, DISPLAY_NAME, DOUBLE_TYPE, DUPS_OK_ACKNOWLEDGE, DURABLE, EJB_CLASS, EJB_CLIENT_JAR, EJB_JAR, EJB_LINK, EJB_LOCAL_REF, EJB_NAME, EJB_QL, EJB_REF, EJB_REF_NAME, EJB_REF_TYPE, EJB_RELATION, EJB_RELATION_NAME, EJB_RELATIONSHIP_ROLE, EJB_RELATIONSHIP_ROLE_NAME, ENTERPRISE_BEANS, ENTITY, ENTITY_REF_TYPE, ENV_ENTRY, ENV_ENTRY_NAME, ENV_ENTRY_TYPE, ENV_ENTRY_VALUE, EXCLUDE_LIST, FALSE_VALUE, FIELD_NAME, FLOAT_TYPE, HOME, INTEGER_TYPE, LARGE_ICON, LOCAL, LOCAL_HOME, LONG_TYPE, MANDATORY, MESSAGE_DRIVEN, MESSAGE_DRIVEN_DESTINATION, MESSAGE_SELECTOR, METHOD, METHOD_INTF, METHOD_NAME, METHOD_PARAM, METHOD_PARAMS, METHOD_PERMISSION, MULTIPLICITY, MULTIPLICITY_MANY, MULTIPLICITY_ONE, NEVER, NONDURABLE, NOT_SUPPORTED, PERSISTENCE_TYPE, PRIM_KEY_CLASS, PRIMKEY_FIELD, QUERY, QUERY_METHOD, QUEUE_TYPE, REENTRANT, RELATIONSHIP_ROLE_SOURCE, RELATIONSHIPS, REMOTE, REQUIRED, REQUIRES_NEW, RES_AUTH, RES_REF_NAME, RES_SHARING_SCOPE, RES_TYPE, RESOURCE_ENV_REF, RESOURCE_ENV_REF_NAME, RESOURCE_ENV_REF_TYPE, RESOURCE_REF, RESULT_TYPE_MAPPING, ROLE_LINK, ROLE_NAME, RUN_AS, SECURITY_IDENTITY, SECURITY_ROLE, SECURITY_ROLE_REF, SESSION, SESSION_REF_TYPE, SESSION_TYPE, SET_TYPE, SHAREABLE_SCOPE, SHORT_TYPE, SMALL_ICON, STATEFUL_TYPE, STATELESS_TYPE, STRING_TYPE, SUBSCRIPTION_DURABILITY, SUPPORTS, TOPIC_TYPE, TRANS_ATTRIBUTE, TRANSACTION_TYPE, TRUE_VALUE, UNCHECKED, UNSHAREABLE_SCOPE, USE_CALLER_IDENTITY

Constructor Summary

Description()

Method Summary

java.lang.String	getDescription()
void	inheritedFields(org.w3c.dom.Document doc, org.w3c.dom.Element e) Insert elements for the fields that subclasses inherit from this object.
void	loadFromElement(org.w3c.dom.Element e) Load the data for this instance from the specified element.
void	setDescription(java.lang.String desc)

Methods inherited from class oracle.toplink.tools.ejbjar.DomObject

toElement, trace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Description

public Description()

Method Detail

getDescription

public java.lang.String getDescription()

Returns:

String the description String or null if not set

inheritedFields

public void inheritedFields(org.w3c.dom.Document doc,
                            org.w3c.dom.Element e)

Insert elements for the fields that subclasses inherit from this object. Note: This means a class needs to know if it has subclasses.

Parameters:

doc - a Document instance used to create elements

e - the parent Element in which to insert the field elements

loadFromElement

public void loadFromElement(org.w3c.dom.Element e)

Load the data for this instance from the specified element.

Specified by:

loadFromElement in class DomObject

Parameters:

e - the *parent* DOM element that may contain a description

setDescription

public void setDescription(java.lang.String desc)

Parameters:

desc - description String