A B C D E F G H I M P R S T U V

A

AbstractFunc - Class in com.rshtech.func
Abstract implementation of a BusinessFunction, providing an implementation of the undo functions and the execute function (which drives the order of execution of the various checks and then the doWork).
AbstractFunc(ApplicationTransaction) - Constructor for class com.rshtech.func.AbstractFunc
 
addException(ApplicationException) - Method in exception com.rshtech.exception.RuleFailureException
 
addException(SystemException) - Method in exception com.rshtech.exception.RuleFailureException
 
addException(ApplicationException) - Method in exception com.rshtech.exception.RuntimeRuleFailureException
 
addException(SystemException) - Method in exception com.rshtech.exception.RuntimeRuleFailureException
 
APP_DEFAULT_ERROR_CODE - Static variable in exception com.rshtech.exception.ApplicationException
 
ApplicationException - Exception in com.rshtech.exception
A base Exception for application exceptions, exceptions which are expected to occur in the course of the application's execution (as opposed to RuntimeExceptions which might occur as a result of unforseen states or values in the system).
ApplicationException() - Constructor for exception com.rshtech.exception.ApplicationException
 
ApplicationException(ErrorCode) - Constructor for exception com.rshtech.exception.ApplicationException
 
ApplicationException(ErrorCode, String) - Constructor for exception com.rshtech.exception.ApplicationException
 
ApplicationException(String) - Constructor for exception com.rshtech.exception.ApplicationException
 
ApplicationException(Throwable) - Constructor for exception com.rshtech.exception.ApplicationException
 
ApplicationException(ErrorCode, Throwable) - Constructor for exception com.rshtech.exception.ApplicationException
 
ApplicationException(String, Throwable) - Constructor for exception com.rshtech.exception.ApplicationException
 
ApplicationException(ErrorCode, String, Throwable) - Constructor for exception com.rshtech.exception.ApplicationException
 
ApplicationTransaction - Interface in com.rshtech.func
Application transactions represent the total work and transactions associated with a user request, that is from the first UI action, to all the server side transactions and work, to the final UI response action before returning to the user.
AppTx - Class in com.rshtech.func
A basic implementation of the ApplicationTransaction interface.
AppTx(String) - Constructor for class com.rshtech.func.AppTx
Construct a new application transaction for the given user id.

B

BASE_ERROR_MESSAGES - Static variable in class com.rshtech.exception.ErrorMessageUtil
 
BASE_PROPERTY - Static variable in class com.rshtech.exception.ErrorMessageUtil
 
BUNDLES_PROPERTY - Static variable in class com.rshtech.exception.ErrorMessageUtil
 
BUS_RULE_DEFAULT_ERROR_CODE - Static variable in exception com.rshtech.exception.BusinessRuleException
 
BusinessFunction - Interface in com.rshtech.func
Interface for business function enclosures to implement.
BusinessRuleException - Exception in com.rshtech.exception
Specialized rule failure exception that pertains to validation issues specifically.
BusinessRuleException() - Constructor for exception com.rshtech.exception.BusinessRuleException
 
BusinessRuleException(ErrorCode) - Constructor for exception com.rshtech.exception.BusinessRuleException
 
BusinessRuleException(ErrorCode, String) - Constructor for exception com.rshtech.exception.BusinessRuleException
 
BusinessRuleException(String) - Constructor for exception com.rshtech.exception.BusinessRuleException
 
BusinessRuleException(Throwable) - Constructor for exception com.rshtech.exception.BusinessRuleException
 
BusinessRuleException(ErrorCode, Throwable) - Constructor for exception com.rshtech.exception.BusinessRuleException
 
BusinessRuleException(String, Throwable) - Constructor for exception com.rshtech.exception.BusinessRuleException
 
BusinessRuleException(ErrorCode, String, Throwable) - Constructor for exception com.rshtech.exception.BusinessRuleException
 

C

checkBusinessRules() - Method in interface com.rshtech.func.BusinessFunction
Check any business rules associated with this business function, throwing a BusinessRuleException if any rule is violated.
checkSecurity() - Method in interface com.rshtech.func.BusinessFunction
Verify the security requirements of this business function have been met, throwing a SecurityException if they have not.
com.rshtech.exception - package com.rshtech.exception
 
com.rshtech.func - package com.rshtech.func
 
com.rshtech.model - package com.rshtech.model
 
CONF_DEFAULT_ERROR_CODE - Static variable in exception com.rshtech.exception.InvalidConfigurationException
 
CONNECT_DEFAULT_ERROR_CODE - Static variable in exception com.rshtech.exception.DataStoreConnectionException
 

D

DATA_DEFAULT_ERROR_CODE - Static variable in exception com.rshtech.exception.DataStoreException
 
DataStoreConnectionException - Exception in com.rshtech.exception
Exception thrown when the an error or exception is encountered while performing operations on a datastore (which could in turn be a database, flatfile, etc).
DataStoreConnectionException() - Constructor for exception com.rshtech.exception.DataStoreConnectionException
 
DataStoreConnectionException(ErrorCode) - Constructor for exception com.rshtech.exception.DataStoreConnectionException
 
DataStoreConnectionException(ErrorCode, String) - Constructor for exception com.rshtech.exception.DataStoreConnectionException
 
DataStoreConnectionException(String) - Constructor for exception com.rshtech.exception.DataStoreConnectionException
 
DataStoreConnectionException(Throwable) - Constructor for exception com.rshtech.exception.DataStoreConnectionException
 
DataStoreConnectionException(ErrorCode, Throwable) - Constructor for exception com.rshtech.exception.DataStoreConnectionException
 
DataStoreConnectionException(String, Throwable) - Constructor for exception com.rshtech.exception.DataStoreConnectionException
 
DataStoreConnectionException(ErrorCode, String, Throwable) - Constructor for exception com.rshtech.exception.DataStoreConnectionException
 
DataStoreException - Exception in com.rshtech.exception
Exception thrown when the an error or exception is encountered while performing operations on a datastore (which could in turn be a database, flatfile, etc).
DataStoreException() - Constructor for exception com.rshtech.exception.DataStoreException
 
DataStoreException(ErrorCode) - Constructor for exception com.rshtech.exception.DataStoreException
 
DataStoreException(ErrorCode, String) - Constructor for exception com.rshtech.exception.DataStoreException
 
DataStoreException(String) - Constructor for exception com.rshtech.exception.DataStoreException
 
DataStoreException(Throwable) - Constructor for exception com.rshtech.exception.DataStoreException
 
DataStoreException(ErrorCode, Throwable) - Constructor for exception com.rshtech.exception.DataStoreException
 
DataStoreException(String, Throwable) - Constructor for exception com.rshtech.exception.DataStoreException
 
DataStoreException(ErrorCode, String, Throwable) - Constructor for exception com.rshtech.exception.DataStoreException
 
DEFAULT_CONFIG - Static variable in class com.rshtech.exception.ErrorMessageUtil
 
doWork() - Method in class com.rshtech.func.AbstractFunc
 

E

equals(Object) - Method in class com.rshtech.exception.ErrorCode
 
equals(ErrorCode) - Method in class com.rshtech.exception.ErrorCode
 
equals(Object) - Method in class com.rshtech.func.AppTx
Returns whether the right-hand-side object is equal to this instance.
ErrorCode - Class in com.rshtech.exception
An error code is a special object that represents a code or key for looking up an error code from a common source.
ErrorCode(String) - Constructor for class com.rshtech.exception.ErrorCode
 
ErrorInformation - Class in com.rshtech.exception
Contains the error/exception information used in the ApplicationException and SystemException classes.
ErrorInformation() - Constructor for class com.rshtech.exception.ErrorInformation
 
ErrorInformation(ErrorCode, String, Throwable) - Constructor for class com.rshtech.exception.ErrorInformation
 
ErrorMessageUtil - Class in com.rshtech.exception
Class for retrieving error messages for a given error code or error code and parameters combination.
execute() - Method in class com.rshtech.func.AbstractFunc
 
execute() - Method in interface com.rshtech.func.Function
Executes a unit of work, throwing any application or system exceptions that occur during execution.

F

Function - Interface in com.rshtech.func
TODO Class summary sentence.

G

getApplicationTransaction() - Method in class com.rshtech.func.AbstractFunc
 
getAppTxId() - Method in interface com.rshtech.func.ApplicationTransaction
Return the application transaction id (that is, a unique identifier for this transaction).
getAppTxId() - Method in class com.rshtech.func.AppTx
 
getCode() - Method in class com.rshtech.exception.ErrorCode
 
getCode() - Method in class com.rshtech.exception.ErrorInformation
 
getDetails() - Method in exception com.rshtech.exception.ApplicationException
 
getDetails() - Method in class com.rshtech.exception.ErrorInformation
 
getDetails() - Method in exception com.rshtech.exception.SystemException
 
getErrorCode() - Method in exception com.rshtech.exception.ApplicationException
 
getErrorCode() - Method in exception com.rshtech.exception.SystemException
 
getErrorMessage() - Method in exception com.rshtech.exception.ApplicationException
 
getErrorMessage() - Method in class com.rshtech.exception.ErrorInformation
 
getErrorMessage(ErrorCode) - Method in class com.rshtech.exception.ErrorMessageUtil
 
getErrorMessage(ParameterizedErrorCode) - Method in class com.rshtech.exception.ErrorMessageUtil
 
getErrorMessage() - Method in exception com.rshtech.exception.SystemException
 
getErrorMessages() - Method in exception com.rshtech.exception.RuleFailureException
 
getErrorMessages() - Method in exception com.rshtech.exception.RuntimeRuleFailureException
 
getExceptions() - Method in exception com.rshtech.exception.RuleFailureException
 
getExceptions() - Method in exception com.rshtech.exception.RuntimeRuleFailureException
 
getInstance() - Static method in class com.rshtech.exception.ErrorMessageUtil
 
getMessage() - Method in exception com.rshtech.exception.ApplicationException
 
getMessage() - Method in exception com.rshtech.exception.SystemException
 
getParameters() - Method in class com.rshtech.exception.ParameterizedErrorCode
 
getResult() - Method in class com.rshtech.func.AbstractFunc
 
getResult() - Method in interface com.rshtech.func.Function
Returns the result of the unit of work, if any.
getRootCause() - Method in class com.rshtech.exception.ErrorInformation
 
getUserId() - Method in interface com.rshtech.func.ApplicationTransaction
Return the id of the user this transaction pertains to.
getUserId() - Method in class com.rshtech.func.AppTx
 

H

hashCode() - Method in class com.rshtech.exception.ErrorCode
 
hashCode() - Method in class com.rshtech.func.AppTx
Implements hashCode() for the identifying or significant fields.

I

InvalidConfigurationException - Exception in com.rshtech.exception
Exception thrown when configuration information is missing or invalid.
InvalidConfigurationException() - Constructor for exception com.rshtech.exception.InvalidConfigurationException
 
InvalidConfigurationException(ErrorCode) - Constructor for exception com.rshtech.exception.InvalidConfigurationException
 
InvalidConfigurationException(ErrorCode, String) - Constructor for exception com.rshtech.exception.InvalidConfigurationException
 
InvalidConfigurationException(String) - Constructor for exception com.rshtech.exception.InvalidConfigurationException
 
InvalidConfigurationException(Throwable) - Constructor for exception com.rshtech.exception.InvalidConfigurationException
 
InvalidConfigurationException(ErrorCode, Throwable) - Constructor for exception com.rshtech.exception.InvalidConfigurationException
 
InvalidConfigurationException(String, Throwable) - Constructor for exception com.rshtech.exception.InvalidConfigurationException
 
InvalidConfigurationException(ErrorCode, String, Throwable) - Constructor for exception com.rshtech.exception.InvalidConfigurationException
 
InvalidStateException - Exception in com.rshtech.exception
Exception thrown when the current state invalid (usually the result of a Runtime error or logic error in the application).
InvalidStateException() - Constructor for exception com.rshtech.exception.InvalidStateException
 
InvalidStateException(ErrorCode) - Constructor for exception com.rshtech.exception.InvalidStateException
 
InvalidStateException(ErrorCode, String) - Constructor for exception com.rshtech.exception.InvalidStateException
 
InvalidStateException(String) - Constructor for exception com.rshtech.exception.InvalidStateException
 
InvalidStateException(Throwable) - Constructor for exception com.rshtech.exception.InvalidStateException
 
InvalidStateException(ErrorCode, Throwable) - Constructor for exception com.rshtech.exception.InvalidStateException
 
InvalidStateException(String, Throwable) - Constructor for exception com.rshtech.exception.InvalidStateException
 
InvalidStateException(ErrorCode, String, Throwable) - Constructor for exception com.rshtech.exception.InvalidStateException
 
isUndone() - Method in class com.rshtech.func.AbstractFunc
Returns true if the function was undone, false otherwise.
isUndone() - Method in interface com.rshtech.func.UndoableFunction
Returns true is a function had undo() called on it.

M

Model - Interface in com.rshtech.model
Implementors of Model represent the "model" portion of a MVC-based design.

P

ParameterizedErrorCode - Class in com.rshtech.exception
A parameterized error code is a specialization of ErrorCode that takes a list of parameters to use in the resulting error message.
ParameterizedErrorCode(ErrorCode, Map<String, ?>) - Constructor for class com.rshtech.exception.ParameterizedErrorCode
 

R

RSH_DEFAULT_CONFIG - Static variable in class com.rshtech.exception.ErrorMessageUtil
 
RuleFailureException - Exception in com.rshtech.exception
Base Exception class for rule failure exceptions (such as validation or business rules).
RuleFailureException() - Constructor for exception com.rshtech.exception.RuleFailureException
 
RuleFailureException(ErrorCode) - Constructor for exception com.rshtech.exception.RuleFailureException
 
RuleFailureException(ErrorCode, String) - Constructor for exception com.rshtech.exception.RuleFailureException
 
RuleFailureException(String) - Constructor for exception com.rshtech.exception.RuleFailureException
 
RuleFailureException(Throwable) - Constructor for exception com.rshtech.exception.RuleFailureException
 
RuleFailureException(ErrorCode, Throwable) - Constructor for exception com.rshtech.exception.RuleFailureException
 
RuleFailureException(String, Throwable) - Constructor for exception com.rshtech.exception.RuleFailureException
 
RuleFailureException(ErrorCode, String, Throwable) - Constructor for exception com.rshtech.exception.RuleFailureException
 
RuntimeRuleFailureException - Exception in com.rshtech.exception
A runtime, base Exception class for rule failure exceptions (such as validation or business rules).
RuntimeRuleFailureException() - Constructor for exception com.rshtech.exception.RuntimeRuleFailureException
 
RuntimeRuleFailureException(ErrorCode) - Constructor for exception com.rshtech.exception.RuntimeRuleFailureException
 
RuntimeRuleFailureException(ErrorCode, String) - Constructor for exception com.rshtech.exception.RuntimeRuleFailureException
 
RuntimeRuleFailureException(String) - Constructor for exception com.rshtech.exception.RuntimeRuleFailureException
 
RuntimeRuleFailureException(Throwable) - Constructor for exception com.rshtech.exception.RuntimeRuleFailureException
 
RuntimeRuleFailureException(ErrorCode, Throwable) - Constructor for exception com.rshtech.exception.RuntimeRuleFailureException
 
RuntimeRuleFailureException(String, Throwable) - Constructor for exception com.rshtech.exception.RuntimeRuleFailureException
 
RuntimeRuleFailureException(ErrorCode, String, Throwable) - Constructor for exception com.rshtech.exception.RuntimeRuleFailureException
 

S

SECURITY_DEFAULT_ERROR_CODE - Static variable in exception com.rshtech.exception.SecurityException
 
SecurityException - Exception in com.rshtech.exception
TODO Class summary sentence.
SecurityException() - Constructor for exception com.rshtech.exception.SecurityException
 
SecurityException(ErrorCode) - Constructor for exception com.rshtech.exception.SecurityException
 
SecurityException(ErrorCode, String) - Constructor for exception com.rshtech.exception.SecurityException
 
SecurityException(String) - Constructor for exception com.rshtech.exception.SecurityException
 
SecurityException(Throwable) - Constructor for exception com.rshtech.exception.SecurityException
 
SecurityException(ErrorCode, Throwable) - Constructor for exception com.rshtech.exception.SecurityException
 
SecurityException(String, Throwable) - Constructor for exception com.rshtech.exception.SecurityException
 
SecurityException(ErrorCode, String, Throwable) - Constructor for exception com.rshtech.exception.SecurityException
 
setCode(String) - Method in class com.rshtech.exception.ErrorCode
 
setCode(ErrorCode) - Method in class com.rshtech.exception.ErrorInformation
 
setDetails(String) - Method in class com.rshtech.exception.ErrorInformation
 
setExceptions(Set<Exception>) - Method in exception com.rshtech.exception.RuleFailureException
 
setExceptions(Set<Exception>) - Method in exception com.rshtech.exception.RuntimeRuleFailureException
 
setParameters(Map<String, ?>) - Method in class com.rshtech.exception.ParameterizedErrorCode
 
setResult(Object) - Method in class com.rshtech.func.AbstractFunc
Allows subclasses to set the result of their work (usually called in doWork()).
setRootCause(Throwable) - Method in class com.rshtech.exception.ErrorInformation
 
STATE_DEFAULT_ERROR_CODE - Static variable in exception com.rshtech.exception.InvalidStateException
 
SYS_DEFAULT_ERROR_CODE - Static variable in exception com.rshtech.exception.SystemException
 
SystemException - Exception in com.rshtech.exception
A base Exception for system exceptions, exceptions which are not expected and occur due to runtime states or values (as opposed to applications exceptions whose possibility is declared in the code and is a compile-time known factor).
SystemException() - Constructor for exception com.rshtech.exception.SystemException
 
SystemException(ErrorCode) - Constructor for exception com.rshtech.exception.SystemException
 
SystemException(ErrorCode, String) - Constructor for exception com.rshtech.exception.SystemException
 
SystemException(String) - Constructor for exception com.rshtech.exception.SystemException
 
SystemException(Throwable) - Constructor for exception com.rshtech.exception.SystemException
 
SystemException(ErrorCode, Throwable) - Constructor for exception com.rshtech.exception.SystemException
 
SystemException(String, Throwable) - Constructor for exception com.rshtech.exception.SystemException
 
SystemException(ErrorCode, String, Throwable) - Constructor for exception com.rshtech.exception.SystemException
 

T

toString() - Method in class com.rshtech.exception.ErrorInformation
 
toString() - Method in class com.rshtech.func.AppTx
 

U

undo() - Method in class com.rshtech.func.AbstractFunc
Undo the business function (marks the function as undone and defers to transactional containers or specific subclasses to take care of the rest).
undo() - Method in interface com.rshtech.func.UndoableFunction
Undoes the function (if possible).
UndoableFunction - Interface in com.rshtech.func
TODO Class summary sentence.
UNKNOWN - Static variable in class com.rshtech.exception.ErrorCode
 

V

validate() - Method in interface com.rshtech.func.BusinessFunction
Validate that any data inputs supplied to the business function meet the minimum data integrity requirements of the function, throwing a ValidationException if they do not.
VALIDATION_DEFAULT_ERROR_CODE - Static variable in exception com.rshtech.exception.RuleFailureException
 
VALIDATION_DEFAULT_ERROR_CODE - Static variable in exception com.rshtech.exception.RuntimeRuleFailureException
 
VALIDATION_DEFAULT_ERROR_CODE - Static variable in exception com.rshtech.exception.ValidationException
 
ValidationException - Exception in com.rshtech.exception
Specialized rule failure exception that pertains to validation issues specifically.
ValidationException() - Constructor for exception com.rshtech.exception.ValidationException
 
ValidationException(ErrorCode) - Constructor for exception com.rshtech.exception.ValidationException
 
ValidationException(ErrorCode, String) - Constructor for exception com.rshtech.exception.ValidationException
 
ValidationException(String) - Constructor for exception com.rshtech.exception.ValidationException
 
ValidationException(Throwable) - Constructor for exception com.rshtech.exception.ValidationException
 
ValidationException(ErrorCode, Throwable) - Constructor for exception com.rshtech.exception.ValidationException
 
ValidationException(String, Throwable) - Constructor for exception com.rshtech.exception.ValidationException
 
ValidationException(ErrorCode, String, Throwable) - Constructor for exception com.rshtech.exception.ValidationException
 

A B C D E F G H I M P R S T U V