com.javelin.fpml.shared
Interface AmericanExercise

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

All Known Implementing Classes:

AmericanExerciseBean

public interface AmericanExercise

extends java.lang.Cloneable, java.io.Serializable

AmericanExercise.java

null

Author:

Javelin Software

See Also:

AmericanExerciseHome, AmericanExerciseSession, AmericanExerciseValidator, AmericanExerciseBean, com.javelin.fpml.shared.lazy.LazyAmericanExerciseBean

Method Summary

java.lang.Object	clone() Clone bean without throwing an Exception.
java.lang.Integer	getAmericanExerciseKey() Get the American Exercise Key.
AdjustableOrRelativeDate	getCommencementDate() Get the Commencement Date.
BusinessCenterTime	getEarliestExerciseTime() Get the Earliest Exercise Time.
ExerciseFeeSchedule	getExerciseFeeSchedule() Get the Exercise Fee Schedule.
AdjustableOrRelativeDate	getExpirationDate() Get the Expiration Date.
BusinessCenterTime	getExpirationTime() Get the Expiration Time.
BusinessCenterTime	getLatestExerciseTime() Get the Latest Exercise Time.
MultipleExercise	getMultipleExercise() Get the Multiple Exercise.
AdjustableOrRelativeDates	getRelevantUnderlyingDate() Get the Relevant Underlying Date.
void	setAmericanExerciseKey(java.lang.Integer americanExerciseKey) Set the American Exercise Key.
void	setCommencementDate(AdjustableOrRelativeDate commencementDate) Set the Commencement Date.
void	setEarliestExerciseTime(BusinessCenterTime earliestExerciseTime) Set the Earliest Exercise Time.
void	setExerciseFeeSchedule(ExerciseFeeSchedule exerciseFeeSchedule) Set the Exercise Fee Schedule.
void	setExpirationDate(AdjustableOrRelativeDate expirationDate) Set the Expiration Date.
void	setExpirationTime(BusinessCenterTime expirationTime) Set the Expiration Time.
void	setLatestExerciseTime(BusinessCenterTime latestExerciseTime) Set the Latest Exercise Time.
void	setMultipleExercise(MultipleExercise multipleExercise) Set the Multiple Exercise.
void	setRelevantUnderlyingDate(AdjustableOrRelativeDates relevantUnderlyingDate) Set the Relevant Underlying Date.

Method Detail

getAmericanExerciseKey

public java.lang.Integer getAmericanExerciseKey()

Get the American Exercise Key.

Returns:

Integer or null if it has not been set.

setAmericanExerciseKey

public void setAmericanExerciseKey(java.lang.Integer americanExerciseKey)
                            throws ValidationException

Set the American Exercise Key.

Parameters:

americanExerciseKey - The value to set.

Throws:

ValidationException - If there was a problem validating the value.

See Also:

AmericanExerciseValidator

getCommencementDate

public AdjustableOrRelativeDate getCommencementDate()

Get the Commencement Date.

Returns:

AdjustableOrRelativeDate or a default value of null if it has not been set.

setCommencementDate

public void setCommencementDate(AdjustableOrRelativeDate commencementDate)
                         throws ValidationException

Set the Commencement Date.

Parameters:

commencementDate - The value to set.

Throws:

ValidationException - If there was a problem validating the value.

See Also:

AmericanExerciseValidator

getExpirationDate

public AdjustableOrRelativeDate getExpirationDate()

Get the Expiration Date.

Returns:

AdjustableOrRelativeDate or a default value of null if it has not been set.

setExpirationDate

public void setExpirationDate(AdjustableOrRelativeDate expirationDate)
                       throws ValidationException

Set the Expiration Date.

Parameters:

expirationDate - The value to set.

Throws:

ValidationException - If there was a problem validating the value.

See Also:

AmericanExerciseValidator

getRelevantUnderlyingDate

public AdjustableOrRelativeDates getRelevantUnderlyingDate()

Get the Relevant Underlying Date.

Returns:

AdjustableOrRelativeDates or a default value of null if it has not been set.

setRelevantUnderlyingDate

public void setRelevantUnderlyingDate(AdjustableOrRelativeDates relevantUnderlyingDate)
                               throws ValidationException

Set the Relevant Underlying Date.

Parameters:

relevantUnderlyingDate - The value to set.

Throws:

ValidationException - If there was a problem validating the value.

See Also:

AmericanExerciseValidator

getEarliestExerciseTime

public BusinessCenterTime getEarliestExerciseTime()

Get the Earliest Exercise Time.

Returns:

BusinessCenterTime or a default value of null if it has not been set.

setEarliestExerciseTime

public void setEarliestExerciseTime(BusinessCenterTime earliestExerciseTime)
                             throws ValidationException

Set the Earliest Exercise Time.

Parameters:

earliestExerciseTime - The value to set.

Throws:

ValidationException - If there was a problem validating the value.

See Also:

AmericanExerciseValidator

getLatestExerciseTime

public BusinessCenterTime getLatestExerciseTime()

Get the Latest Exercise Time.

Returns:

BusinessCenterTime or null if it has not been set.

setLatestExerciseTime

public void setLatestExerciseTime(BusinessCenterTime latestExerciseTime)
                           throws ValidationException

Set the Latest Exercise Time.

Parameters:

latestExerciseTime - The value to set.

Throws:

ValidationException - If there was a problem validating the value.

See Also:

AmericanExerciseValidator

getExpirationTime

public BusinessCenterTime getExpirationTime()

Get the Expiration Time.

Returns:

BusinessCenterTime or a default value of null if it has not been set.

setExpirationTime

public void setExpirationTime(BusinessCenterTime expirationTime)
                       throws ValidationException

Set the Expiration Time.

Parameters:

expirationTime - The value to set.

Throws:

ValidationException - If there was a problem validating the value.

See Also:

AmericanExerciseValidator

getMultipleExercise

public MultipleExercise getMultipleExercise()

Get the Multiple Exercise.

Returns:

MultipleExercise or null if it has not been set.

setMultipleExercise

public void setMultipleExercise(MultipleExercise multipleExercise)
                         throws ValidationException

Set the Multiple Exercise.

Parameters:

multipleExercise - The value to set.

Throws:

ValidationException - If there was a problem validating the value.

See Also:

AmericanExerciseValidator

getExerciseFeeSchedule

public ExerciseFeeSchedule getExerciseFeeSchedule()

Get the Exercise Fee Schedule.

Returns:

ExerciseFeeSchedule or null if it has not been set.

setExerciseFeeSchedule

public void setExerciseFeeSchedule(ExerciseFeeSchedule exerciseFeeSchedule)
                            throws ValidationException

Set the Exercise Fee Schedule.

Parameters:

exerciseFeeSchedule - The value to set.

Throws:

ValidationException - If there was a problem validating the value.

See Also:

AmericanExerciseValidator

clone

public java.lang.Object clone()

Clone bean without throwing an Exception.

Overrides:

clone in class java.lang.Object