com.ail.insurance.policy
Class Excess

java.lang.Object
  extended by com.ail.core.Type
      extended by com.ail.insurance.policy.Excess
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class Excess
extends Type

An Excess represents the amount for which the policy holder is liable before a claim can be made. An excess may be either a "deductible excess" or a standard excess. See the isDeductible() method for details.

Version:
$Revision: 1.4 $
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ail.core.Type
jXPathContext, NOT_PERSISTED
 
Constructor Summary
Excess()
           
 
Method Summary
 void addAssetId(java.lang.String assetId)
          Add a assetId to the collection associated with this object.
 CurrencyAmount getAmount()
           
 java.util.Collection<java.lang.String> getAssetId()
          Fetch the collection of assetId objects associated with this instance.
 java.lang.String getAssetId(int i)
          Get the instance of assetId at a specific index from the collection of String objects associated with this instance.
 int getAssetIdCount()
          Fetch a count of the number of assetId objects associated with this instance.
 java.lang.String getExcessTypeId()
           
 java.lang.String getId()
          Return the ID of this excess.
 java.lang.String getTitle()
           
 boolean isDeductible()
          Returns true if this excess should be treated as a deductible, or false if it is a normal excess.
 boolean isEnabled()
           
 void removeAssetId(int i)
          Remove a specific assetId from the collection of String objects associated with this object.
 void removeAssetId(java.lang.String assetId)
          Remove a specific instance of String from the collection associated with this object.
 void setAmount(CurrencyAmount amount)
           
 void setAssetId(java.util.Collection<java.lang.String> assetId)
          Set the collection of instances of String associated with this object.
 void setAssetId(java.util.Vector<java.lang.String> assetId)
           
 void setDeductible(boolean deductible)
           
 void setEnabled(boolean enabled)
           
 void setExcessTypeId(java.lang.String excessTypeId)
           
 void setId(java.lang.String id)
           
 void setTitle(java.lang.String title)
           
 
Methods inherited from class com.ail.core.Type
addAttribute, clone, deleteLock, deleteSerialVersion, fetchJXPathContext, getAttribute, getAttribute, getAttributeCount, getForeignSystemId, getLock, getSerialVersion, getSystemId, hasLock, hasSerialVersion, hasSystemId, isPersisted, markAsNotPersisted, mergeWithDataFrom, removeAttribute, removeAttribute, setAttribute, setForeignSystemId, setLock, setSerialVersion, setSystemId, xpathGet, xpathGet, xpathIterate, xpathSet
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Excess

public Excess()
Method Detail

getId

public java.lang.String getId()
Return the ID of this excess. This ID is unique within the policy.

Returns:
This excess' ID

setId

public void setId(java.lang.String id)
Parameters:
id -
See Also:
getId()

getAssetId

public java.util.Collection<java.lang.String> getAssetId()
Fetch the collection of assetId objects associated with this instance.

Returns:
A collection of instances of String.

setAssetId

public void setAssetId(java.util.Collection<java.lang.String> assetId)
Set the collection of instances of String associated with this object.

Parameters:
assetId - A collection of instances of String

getAssetIdCount

public int getAssetIdCount()
Fetch a count of the number of assetId objects associated with this instance.

Returns:
Count of assetId objects.

getAssetId

public java.lang.String getAssetId(int i)
Get the instance of assetId at a specific index from the collection of String objects associated with this instance.

Parameters:
i - Index
Returns:
Instance of String found at index i.

removeAssetId

public void removeAssetId(int i)
Remove a specific assetId from the collection of String objects associated with this object.

Parameters:
i - Index of assetId to remove.

addAssetId

public void addAssetId(java.lang.String assetId)
Add a assetId to the collection associated with this object.

Parameters:
assetId - Instance of String to add.

removeAssetId

public void removeAssetId(java.lang.String assetId)
Remove a specific instance of String from the collection associated with this object.

Parameters:
assetId - Object to be removed from the collection.

getAmount

public CurrencyAmount getAmount()

setAmount

public void setAmount(CurrencyAmount amount)

getExcessTypeId

public java.lang.String getExcessTypeId()

setExcessTypeId

public void setExcessTypeId(java.lang.String excessTypeId)

isDeductible

public boolean isDeductible()
Returns true if this excess should be treated as a deductible, or false if it is a normal excess. The meaning of this flag has significance during claims processing. Typically, an excess which is marked as deductible will be processed as follows:
 if ( loss < deductible ) then payment = nill
 otherwise if [( loss - deductible )  < limit] then payment = ( loss - deductible )
 otherwise payment = ( limit - deductible )
Whereas a normal excess is processed like this:
 if ( loss < excess ) then payment = nill
 otherwise if [( loss - excess )  < limit] then payment = ( loss - excess )
 otherwise payment = limit

Returns:
Returns the deductible indicator.

setDeductible

public void setDeductible(boolean deductible)
Parameters:
deductible - The deductible to set.
See Also:
isDeductible()

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String title)

setAssetId

public void setAssetId(java.util.Vector<java.lang.String> assetId)