com.aspc.commander.sql

Class ReportCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.commander.sql.ReportCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class ReportCommand
extends SQLCommand

Runs a report and emails it to the logged in user
Syntax

  REPORT class_name
      [LAYOUT [layout_name]|[SCREEN_KEY layout_key]]
      [WHERE clause]
      [ATTRIBUTES attributes_values]
      [ORDER BY order]
      [FORMAT output_format]
      [EMAIL [SUBJECT subject_tx] [TEMPLATE template_code] [FROM from_address] [TO to_list]]
      [SEND send_to_url]
  

Usage

  REPORT contact WHERE country = 'AU'
  

THREAD MODE: SINGLE THREADED command

Since:

September 06, 2004

Author:

Jason McGrath

Field Summary

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

CURSOR_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	execute(Parser p) execute the command.
java.lang.String	getColumnName(int col) the column name
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

ReportCommand

public ReportCommand(Connection connection,
                     Pattern pattern)

std. Command.

Parameters:

connection - the connection

pattern - the pattern

Method Detail

execute

protected void execute(@Nonnull
                       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)

the column name

Parameters:

col - the column

Returns:

the name

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