Package org.eclnt.workplace.eximport

Class WorkpageStartInfoExtensionAdapter

java.lang.Object

org.eclnt.workplace.eximport.WorkpageStartInfoExtensionAdapter

public class WorkpageStartInfoExtensionAdapter
extends Object

This class was written to support CC-users that have extended the class WorkpageStartInfo and have added own properties. Due to the fact that WorkpageStartInfo is contained in other XML-serialized objects it is not possible to process extension as part of this serializations.

Consequence: if extending WorkpageStartInfo then extensions have to serialize their additional attributes into parameters of WorkpageStartInfo - and deserialize accordingly when the information is transferred into a WorkpageStartInfo...

Extensions of this class need to be registered in system.xml configuration, please check system.xml_template for element "workplace", attribute "workpagestartinfoextensionadapter".

Constructor Summary

Constructors

Constructor	Description
WorkpageStartInfoExtensionAdapter()

Method Summary

Modifier and Type	Method	Description
protected boolean	checkIfTransferDefaultIntoExtensionIsRequired(WorkpageStartInfo wpsi)
protected boolean	checkIfTransferExtensionIntoDefaultIsRequired(WorkpageStartInfo wpsi)
static WorkpageStartInfoExtensionAdapter	instance()
protected boolean	isActive()
final WorkpageStartInfo	transferDefaultIntoExtension(WorkpageStartInfo wpsi)	Transfers the default class into the extended WorkpageStartInfo class.
protected WorkpageStartInfo	transferDefaultIntoExtensionExecute(WorkpageStartInfo wpsi)	You must override this method.
final WorkpageStartInfo	transferExtensionIntoDefault(WorkpageStartInfo wpsiExt)	Transfers the extended class into the default WorkpageStartInfo class.
protected WorkpageStartInfo	transferExtensionIntoDefaultExecute(WorkpageStartInfo wpsiExt)	You must override this method.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkpageStartInfoExtensionAdapter

public WorkpageStartInfoExtensionAdapter()

Method Details

instance

public static WorkpageStartInfoExtensionAdapter instance()

transferExtensionIntoDefault

public final WorkpageStartInfo transferExtensionIntoDefault(WorkpageStartInfo wpsiExt)

Transfers the extended class into the default WorkpageStartInfo class. This method may be called multiple times during the workplace processing for the same WorkpageStartInfo-instance.

Internally the method first calls checkIfTransferExtensionIntoDefaultIsRequired(WorkpageStartInfo) and only executes the transfer if required.

transferDefaultIntoExtension

public final WorkpageStartInfo transferDefaultIntoExtension(WorkpageStartInfo wpsi)

Transfers the default class into the extended WorkpageStartInfo class. This method may be called multiple times during the workplace processing for the same WorkpageStartInfo-instance.

Internally the method first calls checkIfTransferDefaultIntoExtensionIsRequired(WorkpageStartInfo) and only executes the transfer if required.

isActive

protected boolean isActive()

checkIfTransferExtensionIntoDefaultIsRequired

protected boolean checkIfTransferExtensionIntoDefaultIsRequired(WorkpageStartInfo wpsi)

checkIfTransferDefaultIntoExtensionIsRequired

protected boolean checkIfTransferDefaultIntoExtensionIsRequired(WorkpageStartInfo wpsi)

transferExtensionIntoDefaultExecute

protected WorkpageStartInfo transferExtensionIntoDefaultExecute(WorkpageStartInfo wpsiExt)

You must override this method. In your implementation do NOT call the super-implementation!

transferDefaultIntoExtensionExecute

protected WorkpageStartInfo transferDefaultIntoExtensionExecute(WorkpageStartInfo wpsi)

You must override this method. In your implementation do NOT call the super-implementation!