atg.commerce.order.scheduled

Class ScheduledOrderHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.repository.servlet.RepositoryFormHandler

atg.commerce.order.scheduled.ScheduledOrderHandler

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, DropletFormHandler, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, RepositoryFormConstants, RepositoryFormData, java.util.EventListener

public class ScheduledOrderHandler
extends RepositoryFormHandler

This is a form handler for operating on a scheduled order repository item. It is responsible for creating, updating, deleting, activating and deactivating a scheduled order. With the help of ScheduledOrderTools, events are fired for all of these actions.

A scheduled order is rather complex and has some properties that are incapable of being mapped directly from the user interface to the value Dictionary defined in the RepositoryFormHandler. The class ComplexScheduledOrderProperty is created to solve this problem. The ComplexScheduledOrderProperty class has methods remapValueFromScheduledOrder and remapValueFromUserInputFields to facilitate the map between the property in the value Dictionary and those user input fields. For example, the startDate and endDate properties in the value Dictionary are mapped to Year, Month, Date, Hour fields in the user interface.

This form handler supports the following submit methods:

handleRepositoryId

called when is executed. It will retrieve all the property values from the scheduled order repository item whose ID is defined by the repositoryId property. Then the value Dictionary is populated with those properties. Finally, the remapUserInputFieldsFromScheduledOrder method is called to map those complex properties to their proper user interface fields.

handleVerify

called when the user wants to verify the input data and preview the whole scheduled order before it is inserted into the repository. It first resets all the form exceptions, then verifies both the complex and non-complex properties of the scheduled order. Finally, some related properties such as the Beginning Date and the Ending Date of the scheduled order (e.g., make sure the beginning date is ahead of the ending date) are verified.

handleCreate

called when the user wants to create a scheduled order in the order repository. The remapScheduledOrderPropertiesFromUserInputFields method must have been called earlier, usually by handleVerify, to ensure that the value Dictionary contains the correct property values. First, the template order is cloned, if necessary, and the time of the first scheduled run is computed. Then, createItem in the RepositoryFormHandler is called to insert the value Dictionary in the repository. Finally, a JMS ScheduledOrder message is sent to indicate the scheduled order is successfully created.

handleUpdate

called when the user wants to update an existing scheduled order in the order repository. The remapScheduledOrderPropertiesFromUserInputFields method is first called to ensure that the value Dictionary contains the correct updated property values. Then, handleUpdate in the RepositoryFormHandler is called to update the property values in the repository. Finally, a JMS ScheduledOrder message is sent to indicate the scheduled order is successfully updated.

handleDelete

called when the user wants to delete an existing scheduled order in the order repository. The deleteItem method in the RepositoryFormHandler is called to delete the scheduled order from the repository. Then the template order is deleted from the repository. Finally a JMS ScheduledOrder message is sent to indicate the scheduled order is successfully deleted.

handleRemove

called when the user wants to deactivate an existing scheduled order in the order repository. The state of the scheduled order will be changed from active to inactive. A JMS ScheduledOrder message is sent to indicate the scheduled order is successfully updated.

handleRestore

called when the user wants to activate an existing scheduled order in the order repository. The state of the scheduled order will be changed from inactive to active. A JMS ScheduledOrder message is sent to indicate the scheduled order is successfully updated.

The following properties of the ScheduledOrderFormHandler will typically be set in a properties file for this component:

repository

Specifies the repository to operate on.

itemDescriptorName

Specifies the item descriptor that describes the repository items being operated on. For example, new items being added to the repository will be created with the given item desciptor; items being updated are expected to have the given item descriptor.

profile

Specifies the user profile

orderManager

Specifies the order manager

orderTools

Specifies the order tools

transactionManager

Specifies the transaction manager

complexScheduledOrderProperties

Specifies the complex properties. It is a Map property. The key to the map is the name of the complex property. The value to the map is the class name whose class represents the complex property.

The ScheduledOrderFormHandler also has a set of properties that are used to control navigation after a form operation (create, update, delete, etc) has been completed. These properties specify the URLs to redirect on certain error and success conditions. If the value for a particular condition is not set, the form is left on the page defined as the action for that form (i.e. no redirect takes place). Each operation has its own SuccessURL and ErrorURL properties. Thus the following properties are available:

• createSuccessURL
• createErrorURL
• getRepositoryIdSuccessURL
• getRepositoryIdErrorURL
• updateSuccessURL
• updateErrorURL
• deleteSuccessURL
• deleteErrorURL
• moveToSuccessURL
• moveToErrorURL
• removeSuccessURL
• removeErrorURL
• restoreSuccessURL
• restoreErrorURL
• verifySuccessURL
• verifyErrorURL

See Also:

RepositoryFormHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
protected static java.util.ResourceBundle	sResourceBundle Resource Bundle

Fields inherited from class atg.repository.servlet.RepositoryFormHandler

STATUS_ERROR_REDIRECT, STATUS_ERROR_STAY, STATUS_SUCCESS

Fields inherited from class atg.droplet.GenericFormHandler

PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.repository.servlet.RepositoryFormConstants

NULL_SENTINEL, REPOSITORY_ID_PROPERTY_NAME, RESOURCE_BUNDLE_NAME, UPDATE_APPEND, UPDATE_PREPEND, UPDATE_REMOVE, UPDATE_REPLACE

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
ScheduledOrderHandler() Constructs a null ScheduledOrderHandler

Method Summary

Modifier and Type	Method and Description
protected void	ActivateScheduleOrder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method activates a scheduled order by changing its state property from inactive to active.
protected void	deactivateScheduleOrder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method deactivates a scheduled order by changing its state property from active to inactive.
protected int	findMatchingString(java.lang.String[] pArray, java.lang.String pString) This method searches a String in a String array.
java.util.Map	getComplexScheduledOrderMap() Returns property ComplexScheduledOrderMap It iterates through all the elements in ComplexScheduledOrderProperties, instantiates a complexScheduledOrderProperty object for each complex property based on its class name.
java.util.Properties	getComplexScheduledOrderProperties() Returns property ComplexScheduledOrderProperties
protected java.util.Locale	getCurrentLocale() This method gets the current Locale
protected long	getFirstScheduledRun(java.lang.String schedule, long pLastRun) This method is invoked by the preCreateItem method to get the first time when the scheduled order should be processed.
java.lang.String	getGetRepositoryIdErrorURL() Returns property GetRepositoryIdErrorURL
java.lang.String	getGetRepositoryIdSuccessURL() Returns property GetRepositoryIdSuccessURL
atg.service.localeservice.LocaleService	getLocaleService() Returns property LocaleService
protected java.lang.String	getMessage(java.lang.String pMessageCode) This method gets the resource from the input resource name
protected java.lang.String	getMessage(java.lang.String pMessageCOde, java.lang.Object[] args) This method gets the resource from the input resource name and its arguments
java.lang.String	getMoveToErrorURL() Returns property MoveToErrorURL
java.lang.String	getMoveToMode() Returns property MoveToMode
java.lang.String	getMoveToSuccessURL() Returns property MoveToSuccessURL
OrderManager	getOrderManager() Returns property OrderManager
RepositoryItem	getProfile() Returns property Profile
java.lang.Object	getPropertyValue(java.lang.String pProperty) This method gets the value of a property from the value Dictionary.
java.lang.String	getRemoveErrorURL() Returns property RemoveErrorURL
java.lang.String	getRemoveSuccessURL() Returns property RemoveSuccessURL
java.lang.String	getResetErrorURL() Returns property ResetErrorURL
java.lang.String	getResetSuccessURL() Returns property ResetSuccessURL
java.lang.String	getRestoreErrorURL() Returns property RestoreErrorURL
java.lang.String	getRestoreSuccessURL() Returns property RestoreSuccessURL
ScheduledOrderTools	getScheduledOrderTools() Returns property ScheduledOrderTools
javax.transaction.TransactionManager	getTransactionManager() Returns property TransactionManager
java.lang.String	getVerifyErrorURL() Returns property VerifyErrorURL
java.lang.String	getVerifySuccessURL() Returns property VerifySuccessURL
boolean	handleCreate(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when the user wants to create a new scheduled order.
boolean	handleDelete(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when the user wants to delete an existing scheduled order.
boolean	handleMoveToURL(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when the user wants to move to the next input screen
boolean	handleRemove(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when the user wants to deactivate an existing scheduled order.
boolean	handleRepositoryId(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when the user wants to review or update a particular scheduled order.
boolean	handleReset(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when the user wants to all the form values so that this form handler is back to its original state
boolean	handleRestore(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when the user wants to activate an existing scheduled order.
boolean	handleUpdate(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when the user wants to update an existing scheduled order.
boolean	handleVerify(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when the user wants to review the whole scheduled order and verifies the varoius inputs.
protected void	postCreateItem(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called after all processing is done by the handleCreate method.
protected void	postDeleteItem(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called after all processing is done by the handleDelete method.
protected void	postMoveToURL(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called after all processing is done by the processMoveToURL method.
protected void	postRemove(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called after all processing is done by the handleRemove method.
protected void	postRepositoryId(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called after all processing is done by the processRepositoryId method.
protected void	postReset(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called after all processing is done by the resetFormValue method.
protected void	postRestore(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called after all processing is done by the handleRestore method.
protected void	postUpdateItem(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called after all processing is done by the handleUpdate method.
void	postVerify(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called after all processing is done by the verifyUserInputFields method.
protected void	preCreateItem(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called before any processing is done on the handleCreate method.
protected void	preDeleteItem(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before the item is deleted from the repository.
protected void	preMoveToURL(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called before any processing is done on the handleMoveToURL method is dealt with.
protected void	preMoveToVerify(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method verifies the name, schedule mode and template order of the Schedule Order input screen.
protected void	preRemove(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called before any processing is done on the handleRemove method is dealt with.
protected void	preRepositoryId(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called before any processing is done on the handleRepositoryId method is dealt with.
protected void	preReset(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called before any processing is done on the handleReset method is dealt with.
protected void	preRestore(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called before any processing is done on the handleRestore method is dealt with.
protected void	preUpdateItem(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called before any processing is done on the handleUpdate method is dealt with.
void	preVerify(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called before any processing is done on the handleVerify method is dealt with.
protected void	processMoveToURL(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method verifies all the form values before moving to the next input screen.
protected void	processRepositoryId(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method provides the main functionality for the handleRepositoryId method.
boolean	propertyExists(java.lang.String pPropertyName) This method checks whether a property exists in the value Dictionary
protected void	remapScheduledOrderPropertiesFromUserInputFields(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method remaps all the complex properties from the user inputs to its repository.
protected void	remapUserInputFieldsFromScheduledOrderProperties(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method remaps all the complex properties from its repository to the corresponding user interface.
void	removePropertyValue(java.lang.String pPropertyName) This method removes a property from the value Dictionary.
protected void	resetComplexProperties() This method clears and initializes the complex properties
void	resetFormExceptions() This method clears all the form exceptions.
protected void	resetFormValue() This method clears all form values.
protected void	resetValueDictionary() This method clears the value Dictionary
void	setComplexScheduledOrderProperties(java.util.Properties pComplexScheduledOrderProperties) Sets property ComplexScheduledOrderProperties
void	setGetRepositoryIdErrorURL(java.lang.String pGetRepositoryIdErrorURL) Sets property GetRepositoryIdErrorURL
void	setGetRepositoryIdSuccessURL(java.lang.String pGetRepositoryIdSuccessURL) Sets property GetRepositoryIdSuccessURL
void	setLocaleService(atg.service.localeservice.LocaleService pLocaleService) Sets property LocaleService
void	setMoveToErrorURL(java.lang.String pMoveToErrorURL) Sets property MoveToErrorURL
void	setMoveToMode(java.lang.String pMoveToMode) Sets property MoveToMode
void	setMoveToSuccessURL(java.lang.String pMoveToSuccessURL) Sets property MoveToSuccessURL
void	setNonNullPropertyValue(java.lang.String pProperty, java.lang.Object pObject) This method Sets the value of a property into the value Dictionary.
void	setOrderManager(OrderManager pOrderManager) Sets property OrderManager
void	setProfile(RepositoryItem pProfile) Sets property Profile
void	setPropertyValue(java.lang.String pProperty, java.lang.Object pObject) This method Sets the value of a property into the value Dictionary.
void	setRemoveErrorURL(java.lang.String pRemoveErrorURL) Sets property RemoveErrorURL
void	setRemoveSuccessURL(java.lang.String pRemoveSuccessURL) Sets property RemoveSuccessURL
void	setResetErrorURL(java.lang.String pResetErrorURL) Sets property ResetErrorURL
void	setResetSuccessURL(java.lang.String pResetSuccessURL) Sets property ResetSuccessURL
void	setRestoreErrorURL(java.lang.String pRestoreErrorURL) Sets property RestoreErrorURL
void	setRestoreSuccessURL(java.lang.String pRestoreSuccessURL) Sets property RestoreSuccessURL
void	setScheduledOrderTools(ScheduledOrderTools pScheduledOrderTools) Sets property ScheduledOrderTools
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager) Sets property TransactionManager
void	setVerifyErrorURL(java.lang.String pVerifyErrorURL) Sets property VerifyErrorURL
void	setVerifySuccessURL(java.lang.String pVerifySuccessURL) Sets property VerifySuccessURL
protected void	updateScheduleOrderState(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method changes the state of a scheduled order among active, inactive or error.
protected void	verifyComplexScheduledProperties(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method verifies all the complex properties.
protected void	verifyNonComplexScheduledProperties(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method verifies all the non-complex properties.
protected void	verifyOtherRelatedProperties(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method verifies all the related properties.
protected void	verifyStartAndEndDate(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method verifies whether the startDate is less than the endDate.
protected void	verifyUserInputFields(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method provides the main functionality for the handleVerify method.

Methods inherited from class atg.repository.servlet.RepositoryFormHandler

checkFormError, checkFormSuccess, checkForRequiredProperties, deleteItem, getCheckForReadOnlyProperties, getCheckForRequiredProperties, getContentItemDescriptor, getContentNameProperty, getContentPathProperty, getCreateErrorURL, getCreateSuccessURL, getDeleteErrorURL, getDeleteSuccessURL, getEditMapsAsLists, getErrorHandler, getExtractDefaultValuesFromItem, getFolderIdProperty, getItemDescriptor, getItemDescriptorName, getItemProperty, getLogger, getMapKeyValueSeparator, getRemoveReferencesToDeletedItems, getRepository, getRepositoryId, getRepositoryItem, getRepositoryItemEditor, getRepositoryPathName, getRequireIdOnCreate, getSpecifiedIdPropertyValue, getTransactionDemarcation, getTrimProperties, getUpdateErrorURL, getUpdateSuccessURL, getValue, getValueProperty, isClearValueOnSet, isCreateTransientItems, isRequireMapKeys, isSortRepositoryItemSets, isTrimProperty, isUpdateItemsInCollection, postUpdateItemProperties, setCheckForReadOnlyProperties, setCheckForRequiredProperties, setClearValueOnSet, setContentNameProperty, setContentPathProperty, setCreateErrorURL, setCreateSuccessURL, setCreateTransientItems, setDeleteErrorURL, setDeleteSuccessURL, setEditMapsAsLists, setExtractDefaultValuesFromItem, setFolderIdProperty, setItemDescriptorName, setMapKeyValueSeparator, setRemoveReferencesToDeletedItems, setRepository, setRepositoryId, setRepositoryItemEditor, setRepositoryPathName, setRequireIdOnCreate, setRequireMapKeys, setSortRepositoryItemSets, setTrimProperties, setUpdateErrorURL, setUpdateItemsInCollection, setUpdateSuccessURL, setValueProperty, testPropertyAttribute, updateChildItemProperty, updateContentItemValues, updateItem, updateItemProperties, updateListProperty, updateMapProperty

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet, beforeGet

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

sResourceBundle

protected static java.util.ResourceBundle sResourceBundle

Resource Bundle

Constructor Detail

ScheduledOrderHandler

public ScheduledOrderHandler()

Constructs a null ScheduledOrderHandler

Method Detail

setOrderManager

public void setOrderManager(OrderManager pOrderManager)

Sets property OrderManager

Parameters:

pOrderManager - the value to set for property OrderManager

getOrderManager

public OrderManager getOrderManager()

Returns property OrderManager

Returns:

returns property OrderManager

setProfile

public void setProfile(RepositoryItem pProfile)

Sets property Profile

Parameters:

pProfile - the value to set for property Profile

getProfile

public RepositoryItem getProfile()

Returns property Profile

Returns:

returns property Profile

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Sets property TransactionManager

Parameters:

pTransactionManager - the value to set for property TransactionManager

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Returns property TransactionManager

Overrides:

getTransactionManager in class RepositoryFormHandler

Returns:

returns property TransactionManager

setLocaleService

public void setLocaleService(atg.service.localeservice.LocaleService pLocaleService)

Sets property LocaleService

Parameters:

pLocaleService - the value to set for property LocaleService

getLocaleService

public atg.service.localeservice.LocaleService getLocaleService()

Returns property LocaleService

Returns:

returns property LocaleService

setScheduledOrderTools

public void setScheduledOrderTools(ScheduledOrderTools pScheduledOrderTools)

Sets property ScheduledOrderTools

Parameters:

pScheduledOrderTools - the value to set for property ScheduledOrderTools

getScheduledOrderTools

public ScheduledOrderTools getScheduledOrderTools()

Returns property ScheduledOrderTools

Returns:

returns property ScheduledOrderTools

getVerifyErrorURL

public java.lang.String getVerifyErrorURL()

Returns property VerifyErrorURL

Returns:

returns property VerifyErrorURL

setVerifyErrorURL

public void setVerifyErrorURL(java.lang.String pVerifyErrorURL)

Sets property VerifyErrorURL

Parameters:

pVerifyErrorURL - the value to set for property VerifyErrorURL

getVerifySuccessURL

public java.lang.String getVerifySuccessURL()

Returns property VerifySuccessURL

Returns:

returns property VerifySuccessURL

setVerifySuccessURL

public void setVerifySuccessURL(java.lang.String pVerifySuccessURL)

Sets property VerifySuccessURL

Parameters:

pVerifySuccessURL - the value to set for property VerifySuccessURL

getMoveToMode

public java.lang.String getMoveToMode()

Returns property MoveToMode

Returns:

returns property MoveToMode

setMoveToMode

public void setMoveToMode(java.lang.String pMoveToMode)

Sets property MoveToMode

Parameters:

pMoveToMode - the value to set for property MoveToMode

getResetErrorURL

public java.lang.String getResetErrorURL()

Returns property ResetErrorURL

Returns:

returns property ResetErrorURL

setResetErrorURL

public void setResetErrorURL(java.lang.String pResetErrorURL)

Sets property ResetErrorURL

Parameters:

pResetErrorURL - the value to set for property ResetErrorURL

getResetSuccessURL

public java.lang.String getResetSuccessURL()

Returns property ResetSuccessURL

Returns:

returns property ResetSuccessURL

setResetSuccessURL

public void setResetSuccessURL(java.lang.String pResetSuccessURL)

Sets property ResetSuccessURL

Parameters:

pResetSuccessURL - the value to set for property ResetSuccessURL

getMoveToErrorURL

public java.lang.String getMoveToErrorURL()

Returns property MoveToErrorURL

Returns:

returns property MoveToErrorURL

setMoveToErrorURL

public void setMoveToErrorURL(java.lang.String pMoveToErrorURL)

Sets property MoveToErrorURL

Parameters:

pMoveToErrorURL - the value to set for property MoveToErrorURL

getMoveToSuccessURL

public java.lang.String getMoveToSuccessURL()

Returns property MoveToSuccessURL

Returns:

returns property MoveToSuccessURL

setMoveToSuccessURL

public void setMoveToSuccessURL(java.lang.String pMoveToSuccessURL)

Sets property MoveToSuccessURL

Parameters:

pMoveToSuccessURL - the value to set for property MoveToSuccessURL

setRemoveSuccessURL

public void setRemoveSuccessURL(java.lang.String pRemoveSuccessURL)

Sets property RemoveSuccessURL

Parameters:

pRemoveSuccessURL - the value to set for property RemoveSuccessURL

getRemoveSuccessURL

public java.lang.String getRemoveSuccessURL()

Returns property RemoveSuccessURL

Returns:

returns property RemoveSuccessURL

setRemoveErrorURL

public void setRemoveErrorURL(java.lang.String pRemoveErrorURL)

Sets property RemoveErrorURL

Parameters:

pRemoveErrorURL - the value to set for property RemoveErrorURL

getRemoveErrorURL

public java.lang.String getRemoveErrorURL()

Returns property RemoveErrorURL

Returns:

returns property RemoveErrorURL

setRestoreSuccessURL

public void setRestoreSuccessURL(java.lang.String pRestoreSuccessURL)

Sets property RestoreSuccessURL

Parameters:

pRestoreSuccessURL - the value to set for property RestoreSuccessURL

getRestoreSuccessURL

public java.lang.String getRestoreSuccessURL()

Returns property RestoreSuccessURL

Returns:

returns property RestoreSuccessURL

setRestoreErrorURL

public void setRestoreErrorURL(java.lang.String pRestoreErrorURL)

Sets property RestoreErrorURL

Parameters:

pRestoreErrorURL - the value to set for property RestoreErrorURL

getRestoreErrorURL

public java.lang.String getRestoreErrorURL()

Returns property RestoreErrorURL

Returns:

returns property RestoreErrorURL

setGetRepositoryIdSuccessURL

public void setGetRepositoryIdSuccessURL(java.lang.String pGetRepositoryIdSuccessURL)

Sets property GetRepositoryIdSuccessURL

Parameters:

pGetRepositoryIdSuccessURL - the value to set for property GetRepositoryIdSuccessURL

getGetRepositoryIdSuccessURL

public java.lang.String getGetRepositoryIdSuccessURL()

Returns property GetRepositoryIdSuccessURL

Returns:

returns property GetRepositoryIdSuccessURL

setGetRepositoryIdErrorURL

public void setGetRepositoryIdErrorURL(java.lang.String pGetRepositoryIdErrorURL)

Sets property GetRepositoryIdErrorURL

Parameters:

pGetRepositoryIdErrorURL - the value to set for property GetRepositoryIdErrorURL

getGetRepositoryIdErrorURL

public java.lang.String getGetRepositoryIdErrorURL()

Returns property GetRepositoryIdErrorURL

Returns:

returns property GetRepositoryIdErrorURL

setComplexScheduledOrderProperties

public void setComplexScheduledOrderProperties(java.util.Properties pComplexScheduledOrderProperties)

Sets property ComplexScheduledOrderProperties

Parameters:

pComplexScheduledOrderProperties - the value to set for property ComplexScheduledOrderProperties

getComplexScheduledOrderProperties

public java.util.Properties getComplexScheduledOrderProperties()

Returns property ComplexScheduledOrderProperties

Returns:

returns property ComplexScheduledOrderProperties

getComplexScheduledOrderMap

public java.util.Map getComplexScheduledOrderMap()

Returns property ComplexScheduledOrderMap It iterates through all the elements in ComplexScheduledOrderProperties, instantiates a complexScheduledOrderProperty object for each complex property based on its class name.

Returns:

returns property ComplexScheduledOrderMap

getMessage

protected java.lang.String getMessage(java.lang.String pMessageCode)

This method gets the resource from the input resource name

Parameters:

pMessageCode - the resource name

Returns:

the resource

getMessage

protected java.lang.String getMessage(java.lang.String pMessageCOde,
                                      java.lang.Object[] args)

This method gets the resource from the input resource name and its arguments

Parameters:

pMessageCode - the resource name

args - the resouce's arguments

Returns:

the resource

getCurrentLocale

protected java.util.Locale getCurrentLocale()

This method gets the current Locale

Returns:

the current Locale

findMatchingString

protected int findMatchingString(java.lang.String[] pArray,
                                 java.lang.String pString)

This method searches a String in a String array.

Parameters:

pArray - the array to be searched

pString - the searching String

Returns:

the index of the String in the array; -1 if not found

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String pProperty)

This method gets the value of a property from the value Dictionary.

Parameters:

pProperty - the property name

Returns:

the value of the property

setPropertyValue

public void setPropertyValue(java.lang.String pProperty,
                             java.lang.Object pObject)

This method Sets the value of a property into the value Dictionary. If pValue is null, then the property defined by pProperty is removed from the value Dictionary.

Parameters:

pProperty - the property name

pObject - the value of the property

setNonNullPropertyValue

public void setNonNullPropertyValue(java.lang.String pProperty,
                                    java.lang.Object pObject)

This method Sets the value of a property into the value Dictionary. If pValue is null, this method does nothing.

Parameters:

pProperty - the property name

pObject - the value of the property

removePropertyValue

public void removePropertyValue(java.lang.String pPropertyName)

This method removes a property from the value Dictionary.

Parameters:

pPropertyName - the property name

propertyExists

public boolean propertyExists(java.lang.String pPropertyName)

This method checks whether a property exists in the value Dictionary

Parameters:

pPropertyName - the property name

Returns:

a boolean, true if the property exists, false if the property does not exist

remapScheduledOrderPropertiesFromUserInputFields

protected void remapScheduledOrderPropertiesFromUserInputFields(DynamoHttpServletRequest pRequest,
                                                                DynamoHttpServletResponse pResponse)

This method remaps all the complex properties from the user inputs to its repository. It will be called before any create, update or delete action on the repository.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

remapUserInputFieldsFromScheduledOrderProperties

protected void remapUserInputFieldsFromScheduledOrderProperties(DynamoHttpServletRequest pRequest,
                                                                DynamoHttpServletResponse pResponse)

This method remaps all the complex properties from its repository to the corresponding user interface. It will be called before the user interface renders to the user.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

preReset

protected void preReset(DynamoHttpServletRequest pRequest,
                        DynamoHttpServletResponse pResponse)
                 throws javax.servlet.ServletException,
                        java.io.IOException

This method is called before any processing is done on the handleReset method is dealt with. It allows the user to easily extend the functionality for the resetFormValue method to take on their own functionality. It currently does nothing.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

postReset

protected void postReset(DynamoHttpServletRequest pRequest,
                         DynamoHttpServletResponse pResponse)
                  throws javax.servlet.ServletException,
                         java.io.IOException

Called after all processing is done by the resetFormValue method. It currently does nothing

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleReset

public boolean handleReset(DynamoHttpServletRequest pRequest,
                           DynamoHttpServletResponse pResponse)
                    throws javax.servlet.ServletException,
                           java.io.IOException

This method is called when the user wants to all the form values so that this form handler is back to its original state

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleMoveToURL

public boolean handleMoveToURL(DynamoHttpServletRequest pRequest,
                               DynamoHttpServletResponse pResponse)
                        throws javax.servlet.ServletException,
                               java.io.IOException

This method is called when the user wants to move to the next input screen

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

preMoveToURL

protected void preMoveToURL(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)
                     throws javax.servlet.ServletException,
                            java.io.IOException

This method is called before any processing is done on the handleMoveToURL method is dealt with. It allows the user to easily extend the functionality for the processMoveToURL method to take on their own functionality. Currently, it clears out all the form exceptions because we need to clear them out before we make a new verification on the form value.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

processMoveToURL

protected void processMoveToURL(DynamoHttpServletRequest pRequest,
                                DynamoHttpServletResponse pResponse)
                         throws javax.servlet.ServletException,
                                java.io.IOException

This method verifies all the form values before moving to the next input screen.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postMoveToURL

protected void postMoveToURL(DynamoHttpServletRequest pRequest,
                             DynamoHttpServletResponse pResponse)
                      throws javax.servlet.ServletException,
                             java.io.IOException

Called after all processing is done by the processMoveToURL method. It currently does nothing

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preMoveToVerify

protected void preMoveToVerify(DynamoHttpServletRequest pRequest,
                               DynamoHttpServletResponse pResponse)
                        throws javax.servlet.ServletException,
                               java.io.IOException

This method verifies the name, schedule mode and template order of the Schedule Order input screen. If something is wrong, it adds the FormExceptions.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleRepositoryId

public boolean handleRepositoryId(DynamoHttpServletRequest pRequest,
                                  DynamoHttpServletResponse pResponse)
                           throws javax.servlet.ServletException,
                                  java.io.IOException

This method is called when the user wants to review or update a particular scheduled order. The repositoryId of the scheduled order will be set by the setRepositoryId method. This method will first call preRepositoryId. After this has happened it will retrieve all the property values from the repository and set them into the value Dictionary. Then, the postRepositoryId method will be called to map those complex properties to the user interface.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

preRepositoryId

protected void preRepositoryId(DynamoHttpServletRequest pRequest,
                               DynamoHttpServletResponse pResponse)
                        throws javax.servlet.ServletException,
                               java.io.IOException

This method is called before any processing is done on the handleRepositoryId method is dealt with. It allows the user to easily extend the functionality for the processRepositoryId method to take on their own functionality. It currently does nothing.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

processRepositoryId

protected void processRepositoryId(DynamoHttpServletRequest pRequest,
                                   DynamoHttpServletResponse pResponse)
                            throws javax.servlet.ServletException,
                                   java.io.IOException

This method provides the main functionality for the handleRepositoryId method. It maps those complex properties to the user interface if the repository id is not null. If it is null, the form value will be reset. This is only for the case of creating a brand-new scheduled order.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postRepositoryId

protected void postRepositoryId(DynamoHttpServletRequest pRequest,
                                DynamoHttpServletResponse pResponse)
                         throws javax.servlet.ServletException,
                                java.io.IOException

Called after all processing is done by the processRepositoryId method. It currently does nothing

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

verifyUserInputFields

protected void verifyUserInputFields(DynamoHttpServletRequest pRequest,
                                     DynamoHttpServletResponse pResponse)
                              throws java.io.IOException,
                                     javax.servlet.ServletException

This method provides the main functionality for the handleVerify method. It first checks all the complex properties, then checks all the non-complex properties, and finally checks those related properties such as the startDate and endDate.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

verifyComplexScheduledProperties

protected void verifyComplexScheduledProperties(DynamoHttpServletRequest pRequest,
                                                DynamoHttpServletResponse pResponse)
                                         throws java.io.IOException,
                                                javax.servlet.ServletException

This method verifies all the complex properties.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

verifyNonComplexScheduledProperties

protected void verifyNonComplexScheduledProperties(DynamoHttpServletRequest pRequest,
                                                   DynamoHttpServletResponse pResponse)
                                            throws java.io.IOException,
                                                   javax.servlet.ServletException

This method verifies all the non-complex properties. It does nothing now.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

verifyOtherRelatedProperties

protected void verifyOtherRelatedProperties(DynamoHttpServletRequest pRequest,
                                            DynamoHttpServletResponse pResponse)
                                     throws java.io.IOException,
                                            javax.servlet.ServletException

This method verifies all the related properties. Now it just checks whether the endDate is greater than the startDate.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

verifyStartAndEndDate

protected void verifyStartAndEndDate(DynamoHttpServletRequest pRequest,
                                     DynamoHttpServletResponse pResponse)
                              throws java.io.IOException,
                                     javax.servlet.ServletException

This method verifies whether the startDate is less than the endDate.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preVerify

public void preVerify(DynamoHttpServletRequest pRequest,
                      DynamoHttpServletResponse pResponse)
               throws java.io.IOException,
                      javax.servlet.ServletException

This method is called before any processing is done on the handleVerify method is dealt with. It allows the user to easily extend the functionality for the verifyUserInputFields method to take on their own functionality. It currently reset all the form exceptions.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

postVerify

public void postVerify(DynamoHttpServletRequest pRequest,
                       DynamoHttpServletResponse pResponse)
                throws java.io.IOException,
                       javax.servlet.ServletException

Called after all processing is done by the verifyUserInputFields method. It remaps all the scheduled order properties to the user input fields.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleVerify

public boolean handleVerify(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)
                     throws java.io.IOException,
                            javax.servlet.ServletException

This method is called when the user wants to review the whole scheduled order and verifies the varoius inputs. It will first call preVerify method. After this has happened, it will check all the sumbited values and ensure they are valid. If found invalid, FormException will be thrown. Finally, the postVerify method will be called.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

getFirstScheduledRun

protected long getFirstScheduledRun(java.lang.String schedule,
                                    long pLastRun)
                             throws CommerceException

This method is invoked by the preCreateItem method to get the first time when the scheduled order should be processed.

Parameters:

schedule - the user specified schedule in a String format

pLastRun - the last time this order was created. This should typically be the current time.

Returns:

the time in milliseconds representing the time when the order should get created.

Throws:

CommerceException - if an error occurs

preCreateItem

protected void preCreateItem(DynamoHttpServletRequest pRequest,
                             DynamoHttpServletResponse pResponse)
                      throws java.io.IOException,
                             javax.servlet.ServletException

This method is called before any processing is done on the handleCreate method. It allows the user to easily extend the functionality for the handleCreate method to take on their own functionality. It maps the user input fields to the value Dictionary, sets the state of the scheduled order as active, and sets the next scheduled run time of the scheduled order as specified by the schedule. The scheduled order's site is copied from the template order, if present. If there is no template, we use the site ID in the user input fields, if any, or the current site context.

Overrides:

preCreateItem in class RepositoryFormHandler

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

postCreateItem

protected void postCreateItem(DynamoHttpServletRequest pRequest,
                              DynamoHttpServletResponse pResponse)
                       throws java.io.IOException,
                              javax.servlet.ServletException

Called after all processing is done by the handleCreate method. It sends the ScheduledOrder message to indicate that the scheduled order has been successfully added.

Overrides:

postCreateItem in class RepositoryFormHandler

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleCreate

public boolean handleCreate(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)
                     throws java.io.IOException,
                            javax.servlet.ServletException

This method is called when the user wants to create a new scheduled order.

Overrides:

handleCreate in class RepositoryFormHandler

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

updateScheduleOrderState

protected void updateScheduleOrderState(DynamoHttpServletRequest pRequest,
                                        DynamoHttpServletResponse pResponse)
                                 throws java.io.IOException,
                                        javax.servlet.ServletException

This method changes the state of a scheduled order among active, inactive or error.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preUpdateItem

protected void preUpdateItem(DynamoHttpServletRequest pRequest,
                             DynamoHttpServletResponse pResponse)
                      throws java.io.IOException,
                             javax.servlet.ServletException

This method is called before any processing is done on the handleUpdate method is dealt with. It allows the user to easily extend the functionality for the handleUpdate method to take on their own functionality. It verifies the user input fields and maps them to the value Dictionary.

Overrides:

preUpdateItem in class RepositoryFormHandler

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

postUpdateItem

protected void postUpdateItem(DynamoHttpServletRequest pRequest,
                              DynamoHttpServletResponse pResponse)
                       throws java.io.IOException,
                              javax.servlet.ServletException

Called after all processing is done by the handleUpdate method. It sends the ScheduledOrder message to indicate that the scheduled order has been successfully updated.

Overrides:

postUpdateItem in class RepositoryFormHandler

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleUpdate

public boolean handleUpdate(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)
                     throws java.io.IOException,
                            javax.servlet.ServletException

This method is called when the user wants to update an existing scheduled order.

Overrides:

handleUpdate in class RepositoryFormHandler

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preRemove

protected void preRemove(DynamoHttpServletRequest pRequest,
                         DynamoHttpServletResponse pResponse)
                  throws java.io.IOException,
                         javax.servlet.ServletException

This method is called before any processing is done on the handleRemove method is dealt with. It allows the user to easily extend the functionality for the handleRemove method to take on their own functionality. It currently does nothing.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

postRemove

protected void postRemove(DynamoHttpServletRequest pRequest,
                          DynamoHttpServletResponse pResponse)
                   throws java.io.IOException,
                          javax.servlet.ServletException

Called after all processing is done by the handleRemove method. It sends the ScheduledOrder message to indicate that the scheduled order has been successfully updated.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException

deactivateScheduleOrder

protected void deactivateScheduleOrder(DynamoHttpServletRequest pRequest,
                                       DynamoHttpServletResponse pResponse)
                                throws java.io.IOException,
                                       javax.servlet.ServletException

This method deactivates a scheduled order by changing its state property from active to inactive.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException

handleRemove

public boolean handleRemove(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)
                     throws java.io.IOException,
                            javax.servlet.ServletException

This method is called when the user wants to deactivate an existing scheduled order.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preRestore

protected void preRestore(DynamoHttpServletRequest pRequest,
                          DynamoHttpServletResponse pResponse)
                   throws java.io.IOException,
                          javax.servlet.ServletException

This method is called before any processing is done on the handleRestore method is dealt with. It allows the user to easily extend the functionality for the handleRestore method to take on their own functionality. It currently does nothing.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

postRestore

protected void postRestore(DynamoHttpServletRequest pRequest,
                           DynamoHttpServletResponse pResponse)
                    throws java.io.IOException,
                           javax.servlet.ServletException

Called after all processing is done by the handleRestore method. It sends the ScheduledOrder message to indicate that the schdduled order has been successfully updated.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException

ActivateScheduleOrder

protected void ActivateScheduleOrder(DynamoHttpServletRequest pRequest,
                                     DynamoHttpServletResponse pResponse)
                              throws java.io.IOException,
                                     javax.servlet.ServletException

This method activates a scheduled order by changing its state property from inactive to active.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException

handleRestore

public boolean handleRestore(DynamoHttpServletRequest pRequest,
                             DynamoHttpServletResponse pResponse)
                      throws java.io.IOException,
                             javax.servlet.ServletException

This method is called when the user wants to activate an existing scheduled order.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preDeleteItem

protected void preDeleteItem(DynamoHttpServletRequest pRequest,
                             DynamoHttpServletResponse pResponse)
                      throws java.io.IOException,
                             javax.servlet.ServletException

Description copied from class: RepositoryFormHandler

This method is called just before the item is deleted from the repository.

Overrides:

preDeleteItem in class RepositoryFormHandler

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

java.io.IOException - if there was an error with servlet io

javax.servlet.ServletException - if there was an error while executing the code

postDeleteItem

protected void postDeleteItem(DynamoHttpServletRequest pRequest,
                              DynamoHttpServletResponse pResponse)
                       throws java.io.IOException,
                              javax.servlet.ServletException

Called after all processing is done by the handleDelete method. It deletes the template order and sends the ScheduledOrder message to indicate that the scheduled order has been successfully deleted.

Overrides:

postDeleteItem in class RepositoryFormHandler

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if there was an error with servlet io

handleDelete

public boolean handleDelete(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)
                     throws java.io.IOException,
                            javax.servlet.ServletException

This method is called when the user wants to delete an existing scheduled order.

Overrides:

handleDelete in class RepositoryFormHandler

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

resetFormExceptions

public void resetFormExceptions()

This method clears all the form exceptions.

Overrides:

resetFormExceptions in class GenericFormHandler

resetFormValue

protected void resetFormValue()

This method clears all form values.

resetValueDictionary

protected void resetValueDictionary()

This method clears the value Dictionary

resetComplexProperties

protected void resetComplexProperties()

This method clears and initializes the complex properties