com.aspc.commander.sql

Class EmailScreenCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.commander.sql.EmailScreenCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class EmailScreenCommand
extends SQLCommand

Email a screen printout.
Syntax

  EMAIL_SCREEN BASE_OBJ base
               SCREEN_KEY screen
               EMAIL_ACCOUNT sender
               CONTACT_KEY receiver
               [[CONTENT content]|[TEMPLATE template_key]]
               [SUBJECT subject]
               [INLINE]
  

Usage

  /* send email use screen screen@12~2@1 format base on invoice@22~2@1 */
  EMAIL_SCREEN BASE_OBJ invoice@22~2@1 SCREEN_KEY screen@12~2@1
  /* inline option will add screen contents in the email rather than as attachment */
  

THREAD MODE: SINGLE THREADED command

Since:

Jul 26, 2005

Author:

Mei Xiao

Field Summary

Fields inherited from class com.aspc.commander.sql.SQLCommand

CURSOR_SIZE

Constructor Summary

Constructors

Constructor and Description
EmailScreenCommand(Connection connection, Pattern pattern) std.

Method Summary

Modifier and Type	Method and Description
protected void	execute(Parser p) execute the command.
DBEmailSend	generateDBEmail(MutableDataSource mds, java.lang.String subject, DBEmailAccount sender, Contact receiver, java.lang.String content, DBObject base, SDBScreen screen, boolean inline)
java.lang.String	getColumnName(int col) implements getColumnName of interface CommandBuildResultsPlugin.
java.lang.String	getColumnType(int col) Gets the column type for the given column index, starting at one
java.lang.String	getRecordID(int row) the record ID
java.lang.Object	getValue(int row, int col) the value for this row, column

Methods inherited from class com.aspc.commander.sql.SQLCommand

appendResult, appendResult, getCursorName, getRecordKey, isExecuteOnly

Methods inherited from class com.aspc.commander.Command

execute, extMakeThreadName, getConnection, getPattern, getRawTitle, getTitle, makeThreadName, recordCall, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspc.commander.sql.results.CommandBuildResultsPlugin

getRawTitle

Constructor Detail

EmailScreenCommand

public EmailScreenCommand(Connection connection,
                          Pattern pattern)

std. Command.

Parameters:

connection - the connection

pattern - the pattern

Method Detail

generateDBEmail

public DBEmailSend generateDBEmail(MutableDataSource mds,
                                   java.lang.String subject,
                                   DBEmailAccount sender,
                                   Contact receiver,
                                   java.lang.String content,
                                   DBObject base,
                                   SDBScreen screen,
                                   boolean inline)
                            throws java.lang.Exception

Parameters:

mds - the mutable data source

subject -

sender -

receiver -

content -

base - the base object

screen - the screen

inline -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

execute

protected void execute(Parser p)
                throws java.lang.Exception

execute the command.

Specified by:

execute in class Command

Parameters:

p - The parser

Throws:

java.lang.Exception - A serious problem

getColumnName

public java.lang.String getColumnName(int col)

implements getColumnName of interface CommandBuildResultsPlugin. Returns the name for the given column index. Column indexes start at 1

Parameters:

col - the column number to name

Returns:

String the name of the column

getRecordID

public java.lang.String getRecordID(int row)

the record ID

Parameters:

row - the row index

Returns:

the record ID

getColumnType

public java.lang.String getColumnType(int col)

Gets the column type for the given column index, starting at one

Parameters:

col - the column index

Returns:

String the column type

getValue

public java.lang.Object getValue(int row,
                                 int col)

the value for this row, column

Parameters:

row - the row index

col - the column

Returns:

Object the value for the given row and column