org.gatein.wsrp.registration.mapping

Class RegistrationMapping

java.lang.Object

org.gatein.wsrp.registration.mapping.RegistrationMapping

All Implemented Interfaces:

BaseMapping<RegistrationSPI,JCRRegistrationPersistenceManager>

public abstract class RegistrationMapping
extends Object
implements BaseMapping<RegistrationSPI,JCRRegistrationPersistenceManager>

Version:

$Revision$

Author:

Chris Laprun

Field Summary

Fields

Modifier and Type	Field and Description
static String	NODE_NAME

Fields inherited from interface org.gatein.wsrp.jcr.mapping.BaseMapping

JCR_TYPE_NAME_CONSTANT_NAME

Constructor Summary

Constructors

Constructor and Description
RegistrationMapping()

Method Summary

Methods

Modifier and Type	Method and Description
abstract PortletContextMapping	createPortletContext(String id)
abstract RegistrationPropertiesMapping	createProperties()
Class<RegistrationSPI>	getModelClass() Retrieves the Java class of the model object this BaseMapping deals with.
abstract ConsumerMapping	getParent()
abstract String	getPath()
abstract String	getPersistentKey()
abstract Collection<PortletContextMapping>	getPortletContexts()
abstract RegistrationPropertiesMapping	getProperties()
abstract String	getRegistrationHandle()
abstract RegistrationStatus	getStatus()
void	initFrom(RegistrationSPI registration) At this point, this RegistrationMapping should already have been added to its parent
abstract void	setProperties(RegistrationPropertiesMapping rpm)
abstract void	setRegistrationHandle(String handle)
abstract void	setStatus(RegistrationStatus status)
RegistrationSPI	toModel(RegistrationSPI initial, JCRRegistrationPersistenceManager persistenceManager) Converts this BaseMapping into a model object, creating a new one if needed or resetting the specified initial value to the persisted state.
RegistrationSPI	toRegistration(ConsumerSPI consumer, JCRRegistrationPersistenceManager persistenceManager)

Methods inherited from class java.lang.Object

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

Field Detail

NODE_NAME

public static final String NODE_NAME

See Also:

Constant Field Values

Constructor Detail

RegistrationMapping

public RegistrationMapping()

Method Detail

getPersistentKey

public abstract String getPersistentKey()

getStatus

public abstract RegistrationStatus getStatus()

setStatus

public abstract void setStatus(RegistrationStatus status)

getRegistrationHandle

public abstract String getRegistrationHandle()

setRegistrationHandle

public abstract void setRegistrationHandle(String handle)

getPortletContexts

public abstract Collection<PortletContextMapping> getPortletContexts()

createPortletContext

public abstract PortletContextMapping createPortletContext(String id)

getProperties

public abstract RegistrationPropertiesMapping getProperties()

setProperties

public abstract void setProperties(RegistrationPropertiesMapping rpm)

createProperties

public abstract RegistrationPropertiesMapping createProperties()

getPath

public abstract String getPath()

getParent

public abstract ConsumerMapping getParent()

initFrom

public void initFrom(RegistrationSPI registration)

At this point, this RegistrationMapping should already have been added to its parent

Specified by:

initFrom in interface BaseMapping<RegistrationSPI,JCRRegistrationPersistenceManager>

Parameters:

registration -

toModel

public RegistrationSPI toModel(RegistrationSPI initial,
                      JCRRegistrationPersistenceManager persistenceManager)

Description copied from interface: BaseMapping

Converts this BaseMapping into a model object, creating a new one if needed or resetting the specified initial value to the persisted state.

Specified by:

toModel in interface BaseMapping<RegistrationSPI,JCRRegistrationPersistenceManager>

Parameters:

initial - a potentially null initial value that will be reset to the persisted state

persistenceManager - the registry associated with instances of the specified model type

Returns:

a new model instance or the specified initial value reset to the persisted state

getModelClass

public Class<RegistrationSPI> getModelClass()

Description copied from interface: BaseMapping

Retrieves the Java class of the model object this BaseMapping deals with.

Specified by:

getModelClass in interface BaseMapping<RegistrationSPI,JCRRegistrationPersistenceManager>

Returns:

the Java class of the model object this BaseMapping deals with.

toRegistration

public RegistrationSPI toRegistration(ConsumerSPI consumer,
                             JCRRegistrationPersistenceManager persistenceManager)
                               throws RegistrationException

Throws:

RegistrationException