de.hybris.platform.core

Interface ItemDeployment

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

YItemDeploymentWrapper

public interface ItemDeployment
extends java.io.Serializable

Defines the interface of an ItemDeployment

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ItemDeployment.Attribute describes a CMP field
static interface	ItemDeployment.FinderMethod describes a CMP finder
static interface	ItemDeployment.Index describes an index of a database
static interface	ItemDeployment.IndexAttribute Describes the attribute of an Index

Method Summary

Modifier and Type	Method and Description
ItemDeployment.Attribute	getAttribute(java.lang.String qualifier)
java.util.Collection	getAttributes()
java.lang.String	getAuditTableName()
java.lang.String	getColumnName(java.lang.String attribut, java.lang.String database) performance shortcut
java.lang.Class	getConcreteEJBImplementationClass() returns the name of the concrete EJB implementation class this is for example "de.hybris....Country_HJMPWrapper" or whatever class is used during deployment
java.lang.String	getDatabaseTableName()
java.lang.String	getDumpPropertyTableName()
ItemDeployment.FinderMethod	getFinderMethod(java.lang.String methodName, java.lang.String signature)
java.util.Collection	getFinderMethods()
java.lang.Class	getHomeInterface()
java.lang.Class	getImplClass()
ItemDeployment.Index	getIndex(java.lang.String name)
java.util.Collection	getIndexes()
java.lang.String	getName() Returns this deployments name.
java.lang.Class	getRemoteInterface()
java.lang.String	getSuperDeploymentName()
int	getTypeCode()
boolean	isAbstract()
boolean	isFinal() Tells whether this deployment is final - means no other deployment is allowed to inherit from it.
boolean	isGeneric()
boolean	isNonItemDeployment()

Method Detail

isFinal

boolean isFinal()

Tells whether this deployment is final - means no other deployment is allowed to inherit from it.

Returns:

true if deployment is final

getName

java.lang.String getName()

Returns this deployments name. for non-abstract deployments this name forms

Returns:

the name of the deployment

isAbstract

boolean isAbstract()

Returns:

whether this deployment is abstract; means that there is no actual EJB deployed

isGeneric

boolean isGeneric()

Returns:

whether the deployed EJB uses GenericItem ejb classes and interfaces

isNonItemDeployment

boolean isNonItemDeployment()

Returns:

true if this deployment doesnt belong to a item and represents a plain database table ( like props )

getTypeCode

int getTypeCode()

Returns:

the deployed item's typecode, or 0 if this deployment is abstract

getSuperDeploymentName

java.lang.String getSuperDeploymentName()

Returns:

the typecode of the super deployment, only if this a generic deployment

getDatabaseTableName

java.lang.String getDatabaseTableName()

Returns:

the configured database table name; null for abstract deployments

getDumpPropertyTableName

java.lang.String getDumpPropertyTableName()

Returns:

the configured dump property database table name; null for abstract deployments

getAuditTableName

java.lang.String getAuditTableName()

Returns:

the configured audit table name; null for abstract deployments

getHomeInterface

java.lang.Class getHomeInterface()

Returns:

the home interface class, null for generic deployments

getRemoteInterface

java.lang.Class getRemoteInterface()

Returns:

the remote interface class, null for generic deployments

getImplClass

java.lang.Class getImplClass()

Returns:

the impl class, null for generic deployments

getAttributes

java.util.Collection getAttributes()

Returns:

all CMP fields of this deployment

getAttribute

ItemDeployment.Attribute getAttribute(java.lang.String qualifier)

Parameters:

qualifier - the CMP field name

Returns:

a specific CMP field of this deployment

getFinderMethods

java.util.Collection getFinderMethods()

Returns:

all CMP finders of this deployment

getFinderMethod

ItemDeployment.FinderMethod getFinderMethod(java.lang.String methodName,
                                            java.lang.String signature)

Parameters:

methodName - the name of the finder method

signature - the signature of the finder method

Returns:

a specific CMP finder method

getIndexes

java.util.Collection getIndexes()

Returns:

all indexes for this item deployment

getIndex

ItemDeployment.Index getIndex(java.lang.String name)

Parameters:

name - the name of the index to be fetched

Returns:

a single index of this deployment's indexes

getConcreteEJBImplementationClass

java.lang.Class getConcreteEJBImplementationClass()

returns the name of the concrete EJB implementation class this is for example "de.hybris....Country_HJMPWrapper" or whatever class is used during deployment

Returns:

the concrete ejb implementation class

getColumnName

java.lang.String getColumnName(java.lang.String attribut,
                               java.lang.String database)

performance shortcut