oracle.toplink.tools.ejbjar
Class EnterpriseObject

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

All Implemented Interfaces:

EjbJarConstants

Direct Known Subclasses:

Entity, MessageDriven, Session

public abstract class EnterpriseObject

extends Description

Superclass for session, entity and messagedriven beans. Abstract object that contains common state for all three types of enterprise bean objects: entity, session and message-driven beans.

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

EnterpriseObject()

Method Summary

java.lang.String	getDisplayName()
java.lang.String	getEjbClass()
java.util.Vector	getEjbLocalReferences()
java.lang.String	getEjbName()
java.util.Vector	getEjbReferences()
java.util.Vector	getEnvEntries()
java.lang.String	getLargeIcon()
java.util.Vector	getResourceEnvReferences()
java.util.Vector	getResourceReferences()
SecurityIdentity	getSecurityIdentity()
java.lang.String	getSmallIcon()
void	inheritedFields(org.w3c.dom.Document doc, org.w3c.dom.Element e) Insert elements for the fields that subclasses inherit from this object.
boolean	isEntity() Return true if this is an entity object, false if not.
boolean	isMessageDriven() Return true if this is a message-driven object, false if not.
boolean	isSession() Return true if this is a session object, false if not.
void	loadFromElement(org.w3c.dom.Element e) Load the data for this instance from the specified element.
void	setDisplayName(java.lang.String s)
void	setEjbClass(java.lang.String ejbCls)
void	setEjbLocalReferences(java.util.Vector ejbLocalRefs)
void	setEjbName(java.lang.String ejbNm)
void	setEjbReferences(java.util.Vector ejbRefs)
void	setEnvEntries(java.util.Vector entries)
void	setLargeIcon(java.lang.String s)
void	setResourceReferences(java.util.Vector resourceRefs)
void	setSecurityIdentity(SecurityIdentity securityIdent)
void	setSmallIcon(java.lang.String s)
abstract org.w3c.dom.Element	toElement(org.w3c.dom.Document doc) Return the data from this instance as a DOM element.

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

getDescription, setDescription

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

trace

Methods inherited from class java.lang.Object

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

Constructor Detail

EnterpriseObject

public EnterpriseObject()

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Returns:

String the display name String, or null if not set

getEjbClass

public java.lang.String getEjbClass()

Returns:

String the ejb class name String

getEjbName

public java.lang.String getEjbName()

Returns:

String the ejb name String

getEjbReferences

public java.util.Vector getEjbReferences()

Returns:

Vector the collection of EjbReference, or null if not set

getEnvEntries

public java.util.Vector getEnvEntries()

Returns:

Vector the collection of EnvironmentEntry, or null if not set

getLargeIcon

public java.lang.String getLargeIcon()

Returns:

String the largeIcon String, or null if not set

getResourceEnvReferences

public java.util.Vector getResourceEnvReferences()

Returns:

Vector the collection of ResourceEnvReference, or null if not set

getResourceReferences

public java.util.Vector getResourceReferences()

Returns:

Vector the collection of ResourceReference, or null if not set

getSecurityIdentity

public SecurityIdentity getSecurityIdentity()

Returns:

SecurityIdentity the security identity, or null if not set

getSmallIcon

public java.lang.String getSmallIcon()

Returns:

String the smallIcon String, or null if not set

isEntity

public boolean isEntity()

Return true if this is an entity object, false if not.

isMessageDriven

public boolean isMessageDriven()

Return true if this is a message-driven object, false if not.

isSession

public boolean isSession()

Return true if this is a session object, false if not.

setDisplayName

public void setDisplayName(java.lang.String s)

Parameters:

s - the display name String

setEjbClass

public void setEjbClass(java.lang.String ejbCls)

Parameters:

ejbCls - the ejb class name String

setEjbName

public void setEjbName(java.lang.String ejbNm)

Parameters:

ejbNm - the ejb name String

setEjbReferences

public void setEjbReferences(java.util.Vector ejbRefs)

Parameters:

ejbRefs - the collection of EjbReference

getEjbLocalReferences

public java.util.Vector getEjbLocalReferences()

Returns:

Vector the collection of EjbLocalReference, or null if not set

setEjbLocalReferences

public void setEjbLocalReferences(java.util.Vector ejbLocalRefs)

Parameters:

ejbLocalRefs - the collection of EjbReference

setEnvEntries

public void setEnvEntries(java.util.Vector entries)

Parameters:

entries - the collection of EnvironmentEntry

setLargeIcon

public void setLargeIcon(java.lang.String s)

Parameters:

s - the largeIcon String

setResourceReferences

public void setResourceReferences(java.util.Vector resourceRefs)

Parameters:

resourceRefs - the collection of ResourceReference

setSecurityIdentity

public void setSecurityIdentity(SecurityIdentity securityIdent)

Parameters:

securityIdent - the SecurityIdentity object

setSmallIcon

public void setSmallIcon(java.lang.String s)

Parameters:

s - the smallIcon String

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.

Overrides:

inheritedFields in class Description

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.

Overrides:

loadFromElement in class Description

Parameters:

e - the DOM element

toElement

public abstract org.w3c.dom.Element toElement(org.w3c.dom.Document doc)

Return the data from this instance as a DOM element.

Specified by:

toElement in class DomObject

Parameters:

doc - a Document instance used to create elements