Package com.echothree.util.server.control

Class BaseCommand

java.lang.Object

com.echothree.util.server.control.BaseCommand

All Implemented Interfaces:

ExecutionErrorAccumulator, ExecutionWarningAccumulator, SecurityMessageAccumulator

Direct Known Subclasses:

BaseEditCommand, BaseSimpleCommand

public abstract class BaseCommand
extends Object
implements ExecutionWarningAccumulator, ExecutionErrorAccumulator, SecurityMessageAccumulator

Field Summary

Fields

Modifier and Type	Field	Description
protected Session	session

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseCommand(UserVisitPK userVisitPK, CommandSecurityDefinition commandSecurityDefinition)

Method Summary

Modifier and Type	Method	Description
void	addExecutionError(Message message)
void	addExecutionError(String key, Object... values)
void	addExecutionWarning(Message message)
void	addExecutionWarning(String key, Object... values)
void	addSecurityMessage(Message message)
void	addSecurityMessage(String key, Object... values)
protected boolean	canSpecifyParty()
protected boolean	checkCommandSecurityDefinition()
protected boolean	checkOptionalSecurityRoles()
protected abstract BaseResult	execute()
protected BaseResult	getBaseResultAfterErrors()
boolean	getCheckIdentityVerifiedTime()
String	getCommandName()
protected CommandSecurityDefinition	getCommandSecurityDefinition()
Party	getCompanyParty()
String	getComponentVendorName()
protected CoreControl	getCoreControl()
protected EntityInstance	getEntityInstanceByBasePK(BasePK pk)
Messages	getExecutionErrors()
Messages	getExecutionWarnings()
protected SecurityResult	getInsufficientSecurityResult()
protected final org.apache.commons.logging.Log	getLog()
boolean	getLogCommand()
Party	getParty()
PartyPK	getPartyPK()
PartyType	getPartyType()
String	getPartyTypeName()
Currency	getPreferredCurrency()
Currency	getPreferredCurrency(Party party)
DateTimeFormat	getPreferredDateTimeFormat()
DateTimeFormat	getPreferredDateTimeFormat(Party party)
Language	getPreferredLanguage()
Language	getPreferredLanguage(Party party)
TimeZone	getPreferredTimeZone()
TimeZone	getPreferredTimeZone(Party party)
Messages	getSecurityMessages()
Session	getSession()
boolean	getUpdateLastCommandTime()
UserControl	getUserControl()
UserSession	getUserSession()
UserVisit	getUserVisit()
UserVisit	getUserVisitForUpdate()
UserVisitPK	getUserVisitPK()
boolean	hasExecutionErrors()
boolean	hasExecutionWarnings()
boolean	hasSecurityMessages()
protected void	initSession()
protected void	removeFilteredTransferProperty(Class clazz, String property)	This should only be called an override of setupSession().
protected void	removeOption(String option)	This should only be called an override of setupSession().
final CommandResult	run()
final Future<CommandResult>	runAsync()
protected SecurityResult	security()
protected SecurityResult	selfOnly(PartySpec spec)
protected Event	sendEvent(EntityInstance entityInstance, EventTypes eventType, EntityInstance relatedEntityInstance, EventTypes relatedEventType, BasePK createdByBasePK)
protected Event	sendEvent(EntityInstance entityInstance, EventTypes eventType, BasePK relatedBasePK, EventTypes relatedEventType, BasePK createdByBasePK)
protected Event	sendEvent(BasePK basePK, EventTypes eventType, BasePK relatedBasePK, EventTypes relatedEventType, BasePK createdByBasePK)
void	setCheckIdentityVerifiedTime(boolean checkIdentityVerifiedTime)
void	setLogCommand(boolean logCommand)
void	setUpdateLastCommandTime(boolean updateLastCommandTime)
protected void	setupSession()
void	setUserVisitPK(UserVisitPK userVisitPK)
protected void	teardownSession()
protected ValidationResult	validate()

Methods inherited from class java.lang.Object

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

Field Details

session

protected Session session

Constructor Details

BaseCommand

protected BaseCommand(UserVisitPK userVisitPK,
 CommandSecurityDefinition commandSecurityDefinition)

Method Details

getLog

protected final org.apache.commons.logging.Log getLog()

getComponentVendorName

public String getComponentVendorName()

getCommandName

public String getCommandName()

getCompanyParty

public Party getCompanyParty()

getPartyPK

public PartyPK getPartyPK()

getParty

public Party getParty()

getPartyType

public PartyType getPartyType()

getPartyTypeName

public String getPartyTypeName()

getUserVisitPK

public UserVisitPK getUserVisitPK()

setUserVisitPK

public void setUserVisitPK(UserVisitPK userVisitPK)

getUserVisit

public UserVisit getUserVisit()

getUserVisitForUpdate

public UserVisit getUserVisitForUpdate()

getUserSession

public UserSession getUserSession()

getSession

public Session getSession()

getUserControl

public UserControl getUserControl()

getPreferredLanguage

public Language getPreferredLanguage()

getPreferredLanguage

public Language getPreferredLanguage(Party party)

getPreferredCurrency

public Currency getPreferredCurrency()

getPreferredCurrency

public Currency getPreferredCurrency(Party party)

getPreferredTimeZone

public TimeZone getPreferredTimeZone()

getPreferredTimeZone

public TimeZone getPreferredTimeZone(Party party)

getPreferredDateTimeFormat

public DateTimeFormat getPreferredDateTimeFormat()

getPreferredDateTimeFormat

public DateTimeFormat getPreferredDateTimeFormat(Party party)

getCheckIdentityVerifiedTime

public boolean getCheckIdentityVerifiedTime()

setCheckIdentityVerifiedTime

public void setCheckIdentityVerifiedTime(boolean checkIdentityVerifiedTime)

getUpdateLastCommandTime

public boolean getUpdateLastCommandTime()

setUpdateLastCommandTime

public void setUpdateLastCommandTime(boolean updateLastCommandTime)

getLogCommand

public boolean getLogCommand()

setLogCommand

public void setLogCommand(boolean logCommand)

getCommandSecurityDefinition

protected CommandSecurityDefinition getCommandSecurityDefinition()

checkCommandSecurityDefinition

protected boolean checkCommandSecurityDefinition()

checkOptionalSecurityRoles

protected boolean checkOptionalSecurityRoles()

security

protected SecurityResult security()

addSecurityMessage

public void addSecurityMessage(Message message)

Specified by:

addSecurityMessage in interface SecurityMessageAccumulator

addSecurityMessage

public void addSecurityMessage(String key,
 Object... values)

Specified by:

addSecurityMessage in interface SecurityMessageAccumulator

getSecurityMessages

public Messages getSecurityMessages()

Specified by:

getSecurityMessages in interface SecurityMessageAccumulator

hasSecurityMessages

public boolean hasSecurityMessages()

Specified by:

hasSecurityMessages in interface SecurityMessageAccumulator

validate

protected ValidationResult validate()

execute

protected abstract BaseResult execute()

addExecutionWarning

public void addExecutionWarning(Message message)

Specified by:

addExecutionWarning in interface ExecutionWarningAccumulator

addExecutionWarning

public void addExecutionWarning(String key,
 Object... values)

Specified by:

addExecutionWarning in interface ExecutionWarningAccumulator

getExecutionWarnings

public Messages getExecutionWarnings()

Specified by:

getExecutionWarnings in interface ExecutionWarningAccumulator

hasExecutionWarnings

public boolean hasExecutionWarnings()

Specified by:

hasExecutionWarnings in interface ExecutionWarningAccumulator

addExecutionError

public void addExecutionError(Message message)

Specified by:

addExecutionError in interface ExecutionErrorAccumulator

addExecutionError

public void addExecutionError(String key,
 Object... values)

Specified by:

addExecutionError in interface ExecutionErrorAccumulator

getExecutionErrors

public Messages getExecutionErrors()

Specified by:

getExecutionErrors in interface ExecutionErrorAccumulator

hasExecutionErrors

public boolean hasExecutionErrors()

Specified by:

hasExecutionErrors in interface ExecutionErrorAccumulator

getBaseResultAfterErrors

protected BaseResult getBaseResultAfterErrors()

runAsync

public final Future<CommandResult> runAsync()

setupSession

protected void setupSession()

initSession

protected void initSession()

teardownSession

protected void teardownSession()

run

public final CommandResult run()
                        throws BaseException

Throws:

BaseException

canSpecifyParty

protected boolean canSpecifyParty()

selfOnly

protected SecurityResult selfOnly(PartySpec spec)

getInsufficientSecurityResult

protected SecurityResult getInsufficientSecurityResult()

getCoreControl

protected CoreControl getCoreControl()

getEntityInstanceByBasePK

protected EntityInstance getEntityInstanceByBasePK(BasePK pk)

sendEvent

protected Event sendEvent(BasePK basePK,
 EventTypes eventType,
 BasePK relatedBasePK,
 EventTypes relatedEventType,
 BasePK createdByBasePK)

sendEvent

protected Event sendEvent(EntityInstance entityInstance,
 EventTypes eventType,
 BasePK relatedBasePK,
 EventTypes relatedEventType,
 BasePK createdByBasePK)

sendEvent

protected Event sendEvent(EntityInstance entityInstance,
 EventTypes eventType,
 EntityInstance relatedEntityInstance,
 EventTypes relatedEventType,
 BasePK createdByBasePK)

removeOption

protected void removeOption(String option)

This should only be called an override of setupSession(). After that, TransferCaches may have cached knowledge that specific options were set.

Parameters:

option - The option to remove.

removeFilteredTransferProperty

protected void removeFilteredTransferProperty(Class clazz,
 String property)

This should only be called an override of setupSession(). After that, TransferCaches may have cached knowledge that specific properties were filtered.

Parameters:

clazz - The Class whose properties should be examined.

property - The property to remove.