atg.commerce.csr.approvals
Class GenericApprovalsHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.commerce.csr.approvals.GenericApprovalsHandler

All Implemented Interfaces:

atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, java.util.EventListener

Direct Known Subclasses:

OrderApprovalsHandler

public abstract class GenericApprovalsHandler
extends atg.nucleus.GenericService

Base class for Approvals Handler

Field Summary

static java.lang.String	CLASS_VERSION
protected java.lang.String	mApprovalAcceptedJMSType
protected java.lang.String	mApprovalCreatedJMSType
protected java.lang.String	mApprovalItemDescriptorName
protected java.lang.String	mApprovalRejectedJMSType
protected CSRAgentMessagingTools	mCSRAgentMessagingTools

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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

GenericApprovalsHandler()

Method Summary

abstract void	approve(Approval pApproval) Called by ApprovalsManager.approve() Executes specific logic for approving an approval type
abstract atg.commerce.csr.events.ApprovalEvent	getApprovalAcceptedEvent(Approval pApproval) Creates and populates an Event after an approval is approved
java.lang.String	getApprovalAcceptedJMSType() Returns the Approval Accepted JMS Type as a String.
abstract atg.commerce.csr.events.ApprovalEvent	getApprovalCreatedEvent(Approval pApproval) Creates and populates an Event after an approval is created
java.lang.String	getApprovalCreatedJMSType() Returns the Approval Created JMS Type as a String.
java.lang.String	getApprovalItemDescriptorName() Returns the approval item descriptor as a String.
abstract atg.commerce.csr.events.ApprovalEvent	getApprovalRejectedEvent(Approval pApproval) Creates and populates an Event after an approval is rejected
java.lang.String	getApprovalRejectedJMSType() Returns the Approval Rejected JMS Type as a String.
CSRAgentMessagingTools	getCSRAgentMessagingTools() Returns the CSR Agent Messaging Tools.
abstract boolean	isApprovalRequired(Approval pApproval) Called by ApprovalsManager.isApprovalRequired() This method contains logic to determine if an approval is required.
abstract void	loadApproval(Approval pApproval) Called by ApprovalsManager.loadApproval() Loads the specific information for an approval type.
abstract void	reject(Approval pApproval) Called by ApprovalsManager.reject() Executes specific logic for rejecting an approval type
abstract void	saveApproval(Approval pApproval, atg.repository.MutableRepositoryItem pItem) Called by ApprovalsManager.saveApproval() Saves the specific information for an approval type.
void	setApprovalAcceptedJMSType(java.lang.String pApprovalAcceptedJMSType) Sets the Approval Accepted JMS Type as a String.
void	setApprovalCreatedJMSType(java.lang.String pApprovalCreatedJMSType) Sets the Approval Created JMS Type as a String.
void	setApprovalItemDescriptorName(java.lang.String pApprovalItemDescriptor) Sets the approval type as a String.
void	setApprovalRejectedJMSType(java.lang.String pApprovalRejectedJMSType) Sets the Approval Rejected JMS Type as a String.
void	setCSRAgentMessagingTools(CSRAgentMessagingTools mCSRAgentMessagingTools) Sets the CSR Agent Messageing Tools

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

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, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

mApprovalItemDescriptorName

protected java.lang.String mApprovalItemDescriptorName

mApprovalCreatedJMSType

protected java.lang.String mApprovalCreatedJMSType

mApprovalAcceptedJMSType

protected java.lang.String mApprovalAcceptedJMSType

mApprovalRejectedJMSType

protected java.lang.String mApprovalRejectedJMSType

mCSRAgentMessagingTools

protected CSRAgentMessagingTools mCSRAgentMessagingTools

Constructor Detail

GenericApprovalsHandler

public GenericApprovalsHandler()

Method Detail

isApprovalRequired

public abstract boolean isApprovalRequired(Approval pApproval)
                                    throws ApprovalsException

Called by ApprovalsManager.isApprovalRequired() This method contains logic to determine if an approval is required. Returns false if not required, and true if an approval is required

Parameters:

Approval - - an approval object upon which a decision will be made

Throws:

ApprovalsException

saveApproval

public abstract void saveApproval(Approval pApproval,
                                  atg.repository.MutableRepositoryItem pItem)
                           throws ApprovalsException

Called by ApprovalsManager.saveApproval() Saves the specific information for an approval type.

Parameters:

Approval - - the approval whose properties will be saved

MutableRepositoryItem - - The approval repository item

Throws:

ApprovalsException

loadApproval

public abstract void loadApproval(Approval pApproval)
                           throws ApprovalsException

Called by ApprovalsManager.loadApproval() Loads the specific information for an approval type.

Parameters:

Approval - - the approval whose properties will be loaded

Throws:

ApprovalsException

approve

public abstract void approve(Approval pApproval)
                      throws ApprovalsException

Called by ApprovalsManager.approve() Executes specific logic for approving an approval type

Parameters:

Approval - - the approval to be approved

Throws:

ApprovalsException

reject

public abstract void reject(Approval pApproval)
                     throws ApprovalsException

Called by ApprovalsManager.reject() Executes specific logic for rejecting an approval type

Parameters:

Approval - - the approval to be approved

Throws:

ApprovalsException

getApprovalCreatedEvent

public abstract atg.commerce.csr.events.ApprovalEvent getApprovalCreatedEvent(Approval pApproval)

Creates and populates an Event after an approval is created

Parameters:

Approval - - the approval to be approved

Throws:

ApprovalsException

getApprovalAcceptedEvent

public abstract atg.commerce.csr.events.ApprovalEvent getApprovalAcceptedEvent(Approval pApproval)

Creates and populates an Event after an approval is approved

Parameters:

Approval - - the approval to be approved

Throws:

ApprovalsException

getApprovalRejectedEvent

public abstract atg.commerce.csr.events.ApprovalEvent getApprovalRejectedEvent(Approval pApproval)

Creates and populates an Event after an approval is rejected

Parameters:

Approval - - the approval to be approved

Throws:

ApprovalsException

getApprovalItemDescriptorName

public java.lang.String getApprovalItemDescriptorName()

Returns the approval item descriptor as a String.

Returns:

the ApprovalItemDescriptorName

setApprovalItemDescriptorName

public void setApprovalItemDescriptorName(java.lang.String pApprovalItemDescriptor)

Sets the approval type as a String.

Parameters:

pApprovalItemDescriptor - the ApprovalItemDescriptor to set

setApprovalCreatedJMSType

public void setApprovalCreatedJMSType(java.lang.String pApprovalCreatedJMSType)

Sets the Approval Created JMS Type as a String.

Parameters:

pApprovalCreatedJMSType - the ApprovalCreatedJMSType to set

getApprovalCreatedJMSType

public java.lang.String getApprovalCreatedJMSType()

Returns the Approval Created JMS Type as a String.

Returns:

the mApprovalCreatedJMSType

setApprovalAcceptedJMSType

public void setApprovalAcceptedJMSType(java.lang.String pApprovalAcceptedJMSType)

Sets the Approval Accepted JMS Type as a String.

Parameters:

pApprovalAcceptedJMSType - the ApprovalAcceptedJMSType to set

getApprovalAcceptedJMSType

public java.lang.String getApprovalAcceptedJMSType()

Returns the Approval Accepted JMS Type as a String.

Returns:

the mApprovalAcceptedJMSType

setApprovalRejectedJMSType

public void setApprovalRejectedJMSType(java.lang.String pApprovalRejectedJMSType)

Sets the Approval Rejected JMS Type as a String.

Parameters:

pApprovalRejectedJMSType - the ApprovalRejectedJMSType to set

getApprovalRejectedJMSType

public java.lang.String getApprovalRejectedJMSType()

Returns the Approval Rejected JMS Type as a String.

Returns:

the mApprovalRejectedJMSType

setCSRAgentMessagingTools

public void setCSRAgentMessagingTools(CSRAgentMessagingTools mCSRAgentMessagingTools)

Sets the CSR Agent Messageing Tools

Parameters:

mCSRAgentMessagingTools - the mCSRAgentMessagingTools to set

getCSRAgentMessagingTools

public CSRAgentMessagingTools getCSRAgentMessagingTools()

Returns the CSR Agent Messaging Tools.

Returns:

the mCSRAgentMessagingTools