com.instantbank.lettertemplate.control.event
Class BatchStartEvent

java.lang.Object
  |
  +--com.instantbank.lettertemplate.control.event.LetterTemplateEventSupport
        |
        +--com.instantbank.lettertemplate.control.event.BatchStartEvent
All Implemented Interfaces:
LetterTemplateEvent, java.io.Serializable

public class BatchStartEvent
extends LetterTemplateEventSupport

Letter Batch Start usecase: This event is sent from the web tier to the EJB Controller to notify the EJB Controller that an action needs to be made in the letter batch start model data.

Author:
Instant-bank (Jorge Cardenas)
See Also:
Serialized Form

Field Summary
private  int actionType
          action requested by the user
private  LetterBatchStartModel batchStart
          letter batch
private  java.lang.String companyId
          current company
static int LIST_BATCH_START
          action constant of getting the letters list of the current company
static int UPDATE_BATCH_START
           
private  java.lang.Long userId
          current user
 
Constructor Summary
BatchStartEvent(int actionType, java.lang.String companyId, java.lang.Long userId, LetterBatchStartModel batchStart)
          constructor: initializes attributes
 
Method Summary
 int getActionType()
          get method for actionType
 LetterBatchStartModel getBatchStart()
          get method for batchStart
 java.lang.String getCompanyId()
          get method for companyId
 java.lang.String getEventName()
          JNDI name for the event: LetterTemplateController EJB registers this env variable
 java.lang.Long getUserId()
          get method for userId
 java.lang.String toString()
          String representation of the event
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

LIST_BATCH_START

public static final int LIST_BATCH_START
action constant of getting the letters list of the current company

UPDATE_BATCH_START

public static final int UPDATE_BATCH_START

actionType

private int actionType
action requested by the user

companyId

private java.lang.String companyId
current company

userId

private java.lang.Long userId
current user

batchStart

private LetterBatchStartModel batchStart
letter batch
Constructor Detail

BatchStartEvent

public BatchStartEvent(int actionType,
                       java.lang.String companyId,
                       java.lang.Long userId,
                       LetterBatchStartModel batchStart)
constructor: initializes attributes
Parameters:
actionType - action requested by the user
companyId - current company
userId - current user
batchStart - letter batch
Method Detail

getActionType

public int getActionType()
get method for actionType
Returns:
The actionType value

getCompanyId

public java.lang.String getCompanyId()
get method for companyId
Returns:
The companyId value

getUserId

public java.lang.Long getUserId()
get method for userId
Returns:
The userId value

getBatchStart

public LetterBatchStartModel getBatchStart()
get method for batchStart
Returns:
The batchStart value

toString

public java.lang.String toString()
String representation of the event
Overrides:
toString in class java.lang.Object
Returns:
text of event

getEventName

public java.lang.String getEventName()
JNDI name for the event: LetterTemplateController EJB registers this env variable
Overrides:
getEventName in class LetterTemplateEventSupport
Returns:
The eventName value