com.ibm.commerce.utf.commands

Class RFQNotificationMonitorBaseCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.ControllerCommandImpl

com.ibm.commerce.utf.commands.RFQNotificationMonitorBaseCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, RFQNotificationMonitorBaseCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

Direct Known Subclasses:

RFQNotificationClosedMonitorCmdImpl, RFQNotificationCompletedMonitorCmdImpl, RFQNotificationSubmittedMonitorCmdImpl

public class RFQNotificationMonitorBaseCmdImpl
extends ControllerCommandImpl
implements RFQNotificationMonitorBaseCmd

Implementation of the base command for monitoring when notifications need to be sent.

This is the default implementation of the RFQNotificationMonitorBaseCmd. This command calls the following TaskCommands:

• ListUsersInMemberGroupCmd

This command uses the following AccessBeans/DataBeans

• SchedulerConfigAccessBean
• SchedulerStatusAccessBean
• UserAccessBean
• UserManageBean

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.utf.commands.RFQNotificationMonitorBaseCmd

defaultCommandClassName, NAME, NOTIFY_RFQ_OWNER_PARAM, SCHJOB_COMPETED_STATE_FLAG, SCHJOB_REFNUM_PARAM, SELLER_MBR_GROUP_NAME_TO_NOTIFY_OWNERID_PARAM, SELLER_MBR_GROUP_NAME_TO_NOTIFY_PARAM, siteStoreId

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
RFQNotificationMonitorBaseCmdImpl() RFQNotificationMonitorBaseCmdImpl constructor.

Method Summary

Modifier and Type	Method and Description
boolean	getNotifyRFQOwner() Gets the RFQ owner is to be notified.
java.sql.Timestamp	getScheduledJobLastCompletionTimestamp() Returns the last time the scheduled job was successfully completed.
java.lang.String	getSellerMemberGroupNameToNotify() Gets member group name defined in the MBRGRP table that is used to retrieve the users in the seller's organization in order to send notifications to.
java.lang.Long	getSellerMemberGroupToNotifyOwnerId() Gets owner id of the member group name defined by the setSellerMemberGroupNameToNotify() method.
UserAccessBean[]	getUsersToNotify(RFQAccessBean rfq) Return a list of users to notify.
void	setNotifyRFQOwner(boolean aFlag) Sets whether the RFQ owner is notified.
void	setSellerMemberGroupNameToNotify(java.lang.String mbrGroup) Sets member group name defined in the MBRGRP table that is used to retrieve the users in the seller's organization in order to send notifications to.
void	setSellerMemberGroupToNotifyOwnerId(java.lang.Long mbrGrpOwnerId) Sets owner id of the member group name defined by the setSellerMemberGroupNameToNotify() method.
void	updateCommandContextWithUsersPreferredLanguage(UserAccessBean user) Sets the command context language id to that of the user's preferred language.
void	validateParameters() Checks if the jobRefNum was specified with command.

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setRequestProperties, setResponseProperties, setRetriable, setViewInputProperties

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, performExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.commerce.command.ControllerCommand

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.AccCommand

accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

RFQNotificationMonitorBaseCmdImpl

public RFQNotificationMonitorBaseCmdImpl()

RFQNotificationMonitorBaseCmdImpl constructor.

Method Detail

getNotifyRFQOwner

public boolean getNotifyRFQOwner()

Gets the RFQ owner is to be notified.

Specified by:

getNotifyRFQOwner in interface RFQNotificationMonitorBaseCmd

Returns:

True if the RFQ owner is to be notified, false otherwise.

getScheduledJobLastCompletionTimestamp

public java.sql.Timestamp getScheduledJobLastCompletionTimestamp()
                                                          throws ECException

Returns the last time the scheduled job was successfully completed. Returns the earliest timestamp possible if the job was never successfully completed before.

Returns:

The last time the scheduled job was successfully completed.

Throws:

ECException.

ECException

getSellerMemberGroupNameToNotify

public java.lang.String getSellerMemberGroupNameToNotify()

Gets member group name defined in the MBRGRP table that is used to retrieve the users in the seller's organization in order to send notifications to.

Specified by:

getSellerMemberGroupNameToNotify in interface RFQNotificationMonitorBaseCmd

Returns:

The member group name defined in the MBRGRP table that is used to retrieve the users in the seller's organization in order to send notifications to.

getSellerMemberGroupToNotifyOwnerId

public java.lang.Long getSellerMemberGroupToNotifyOwnerId()

Gets owner id of the member group name defined by the setSellerMemberGroupNameToNotify() method.

Specified by:

getSellerMemberGroupToNotifyOwnerId in interface RFQNotificationMonitorBaseCmd

Returns:

The owner id of the member group name defined by the setSellerMemberGroupNameToNotify() method.

getUsersToNotify

public UserAccessBean[] getUsersToNotify(RFQAccessBean rfq)
                                  throws ECException

Return a list of users to notify.

Parameters:

RFQAccessBean - The RFQs.

Returns:

An array of UserAccessBean objects.

Throws:

ECException.

ECException

setNotifyRFQOwner

public void setNotifyRFQOwner(boolean aFlag)

Sets whether the RFQ owner is notified.

Specified by:

setNotifyRFQOwner in interface RFQNotificationMonitorBaseCmd

Parameters:

aFlag - Sets whether the RFQ owner is notified. True the RFQ owner is notified, false the RFQ owner is not notified.

setSellerMemberGroupNameToNotify

public void setSellerMemberGroupNameToNotify(java.lang.String mbrGroup)

Sets member group name defined in the MBRGRP table that is used to retrieve the users in the seller's organization in order to send notifications to.

Specified by:

setSellerMemberGroupNameToNotify in interface RFQNotificationMonitorBaseCmd

Parameters:

mbrGroup - The member group name defined in the MBRGRP table that is used to retrieve the users in the seller's organization in order to send notifications to.

setSellerMemberGroupToNotifyOwnerId

public void setSellerMemberGroupToNotifyOwnerId(java.lang.Long mbrGrpOwnerId)

Sets owner id of the member group name defined by the setSellerMemberGroupNameToNotify() method.

Specified by:

setSellerMemberGroupToNotifyOwnerId in interface RFQNotificationMonitorBaseCmd

Parameters:

mbrGrpOwnerId - The owner id of the member group name defined by the setSellerMemberGroupNameToNotify() method.

updateCommandContextWithUsersPreferredLanguage

public void updateCommandContextWithUsersPreferredLanguage(UserAccessBean user)
                                                    throws ECException

Sets the command context language id to that of the user's preferred language. This also resets the locale in the command context.

Parameters:

UserAccessBean - The user.

Throws:

ECException

validateParameters

public void validateParameters()
                        throws ECException

Checks if the jobRefNum was specified with command. This parameter is the scheduled job in the SCHCONFIG table. The reference number is needed to retrieve the last successful job completion end time.

Optional parameters are:
sellerMemberGroupNameToNotify, the group name defined in the mbrgrp table that is used to notify the seller users.
sellerMemberGroupToNotifyOwnerId, the group name owner defined in the mbrgrp table that is used to notify the seller users. If the sellerMemberGroupToNotify parameter is specified then this parameter must also be specified.
storeId, the store identifier number in the command context. If the storeId is 0 then this command works on all the RFQs for the site.


Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException

See Also:

ECCommand#validateParameters()