com.ibm.commerce.scheduler.commands

Interface AddBroadcastJobCmd

All Superinterfaces:

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

All Known Implementing Classes:

AddBroadcastJobCmdImpl

public interface AddBroadcastJobCmd
extends ControllerCommand

Adds a new broadcast job to the WebSphere Commerce Server's scheduler.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation of this command.
static java.lang.String	NAME The name of this command.
static java.lang.String	URLNAME The defined command name found in the url registry.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getJobId() Gets the job id.
java.lang.Long	getJobInstanceId() Gets the job instance id.
void	setName(java.lang.String name) Sets the name of user.
void	setPathInfo(java.lang.String pathInfo) Sets the name of the command to be added to the scheduler.
void	setQueryString(java.lang.String parameters) Sets the query string associated with the job.
void	setUrl(java.lang.String url) Sets the url to be redirected to at the end of the command.
void	setUserRefNum(java.lang.Long refnum) Sets the user Id.

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, validateParameters

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

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this command.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation of this command.

See Also:

Constant Field Values

URLNAME

static final java.lang.String URLNAME

The defined command name found in the url registry.

See Also:

Constant Field Values

Method Detail

getJobId

java.lang.Long getJobId()

Gets the job id.

Returns:

The job reference number of the new job.

getJobInstanceId

java.lang.Long getJobInstanceId()

Gets the job instance id.

Returns:

The instance reference number of the record to indicate when the job needs to run.

setName

void setName(java.lang.String name)

Sets the name of user.

Parameters:

name - the logon id of the user to run the command as.

setPathInfo

void setPathInfo(java.lang.String pathInfo)

Sets the name of the command to be added to the scheduler.

Parameters:

pathInfo - the command to execute.

setQueryString

void setQueryString(java.lang.String parameters)

Sets the query string associated with the job.

Parameters:

parameters - the parameters to pass to the command when it is executed.

setUrl

void setUrl(java.lang.String url)

Sets the url to be redirected to at the end of the command.

Parameters:

url - the URL to redirect to after the broadcast job is added.

setUserRefNum

void setUserRefNum(java.lang.Long refnum)

Sets the user Id.

Parameters:

refnum - the member id of user which will run the command.