Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.0.0)

E17483-01

oracle.jbo
Class AttrValException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by oracle.jbo.JboWarning
                  extended by oracle.jbo.JboException
                      extended by oracle.jbo.ValidationException
                          extended by oracle.jbo.AttrValException
All Implemented Interfaces:
java.io.Serializable, JboMessage, MetaObjectBase, ExprWrappable, Properties
Direct Known Subclasses:
AttrSetValException, DataCreationException, ReadOnlyAttrException, UpdateAttrPrivilegeException

public class AttrValException
extends ValidationException

Indicates a attribute validation error. This class may be extended to provide localizable exceptions to arbitrary bundle classes.

Since:
JDeveloper 3.0
See Also:
Serialized Form

Field Summary
protected  java.lang.Object mAttrValue
           
 
Fields inherited from class oracle.jbo.ValidationException
mRowDefFullName
 
Fields inherited from class oracle.jbo.JboException
mHasPeerException
 
Fields inherited from class oracle.jbo.JboWarning
mHelper, SEVERITY_ERROR, SEVERITY_RAC_RECOVERABLE_ERROR, SEVERITY_RECOVERABLE_ERROR, SEVERITY_VETOABLE_WARNING, SEVERITY_WARNING
 
Fields inherited from interface oracle.jbo.common.MetaObjectBase
TYP_APP_MODULE, TYP_ATTRIBUTE, TYP_ATTRIBUTE_LIST_WITH_DEF, TYP_CATEGORY, TYP_COMPONENT_OBJECT, TYP_DATA_CONTROL, TYP_DEF_ANY, TYP_DEF_APP_MODULE, TYP_DEF_ASSOC_END, TYP_DEF_ATTRIBUTE, TYP_DEF_COMPONENT_OBJECT, TYP_DEF_DOMAIN, TYP_DEF_ENTITY_ASSOC, TYP_DEF_ENTITY_OBJECT, TYP_DEF_KEY, TYP_DEF_LIST_BINDING, TYP_DEF_METHOD, TYP_DEF_OPERATION, TYP_DEF_PACKAGE, TYP_DEF_VIEW_ACCESSOR, TYP_DEF_VIEW_LINK, TYP_DEF_VIEW_LINK_END, TYP_DEF_VIEW_OBJECT, TYP_DOMAIN, TYP_ENTITY_ASSOC, TYP_ENTITY_OBJECT, TYP_ENTITY_ROW, TYP_ENTITY_ROW_SET, TYP_ENTITY_ROW_SET_ITERATOR, TYP_ENTITY_USAGE, TYP_PACKAGE, TYP_PERS_DEF_APP_MODULE, TYP_PERS_DEF_ATTRIBUTE, TYP_PERS_DEF_COMPONENT_OBJECT, TYP_PERS_DEF_DOMAIN, TYP_PERS_DEF_ENTITY_ASSOC, TYP_PERS_DEF_ENTITY_OBJECT, TYP_PERS_DEF_OFFSET, TYP_PERS_DEF_OPERATION, TYP_PERS_DEF_PACKAGE, TYP_PERS_DEF_VARIABLE, TYP_PERS_DEF_VIEW_LINK, TYP_PERS_DEF_VIEW_OBJECT, TYP_SERVICE_VIEW_USAGE, TYP_SORT_CRITERIA, TYP_TRANSACTION, TYP_TRIGGER_TYPE, TYP_VALIDATOR_TYPE, TYP_VARIABLE, TYP_VARIABLE_WHERE_CLAUSE, TYP_VIEW_CRITERIA, TYP_VIEW_CRITERIA_ITEM, TYP_VIEW_CRITERIA_ROW, TYP_VIEW_LINK, TYP_VIEW_OBJECT, TYP_VIEW_ROW, TYP_VIEW_ROW_SET, TYP_VIEW_ROW_SET_ITERATOR, TYP_VIEW_USAGE
 
Constructor Summary
protected AttrValException(java.lang.Class resBundleClass, java.lang.String errorCode, java.lang.Object[] params)
          Creates a localizable exception for an object.
  AttrValException(java.lang.Class resBundleClass, java.lang.String errorCode, java.lang.String defName, java.lang.String attrName, java.lang.Object value, java.util.ArrayList exceptions)
          Creates a localizable exception for an object.
  AttrValException(java.lang.Class resBundleClass, java.lang.String errorCode, java.lang.String defName, java.lang.String attrName, java.lang.Object value, java.util.ArrayList exceptions, boolean hasPeer)
          Creates a localizable exception for an object.
  AttrValException(int objType, java.lang.Class resBundleClass, java.lang.String errorCode, java.lang.String objFullName, java.lang.String attrName)
          Creates a localizable exception for an object.
  AttrValException(int objType, java.lang.Class resBundleClass, java.lang.String errorCode, java.lang.String objFullName, java.lang.String attrName, java.lang.Object value, java.lang.Exception[] peerExceptions, boolean peer)
          Creates a localizable exception for an object.
  AttrValException(int objType, ResourceBundleDef resBundleDef, java.lang.String errorCode, java.lang.String objFullName, java.lang.String attrName)
          Creates a localizable exception for an object.
  AttrValException(int objType, ResourceBundleDef resBundleDef, java.lang.String errorCode, java.lang.String objFullName, java.lang.String attrName, java.lang.Object value, java.lang.Exception[] peerExceptions, boolean peer)
          Creates a localizable exception for an object.
  AttrValException(int objType, java.lang.String msg, java.lang.String errorCode, java.lang.String objFullName, java.lang.String attrName)
          Creates a non-localizable exception for an object.
 
Method Summary
 void doEntityToVOMapping(ApplicationModule rootAm, ViewObject[] vos)
           
 boolean equals(java.lang.Object theOther)
           
 ValidationException getAttributeException(java.lang.String rowDefName, java.lang.String voAttrName)
           
 java.lang.String getAttrName()
           
 java.lang.Object getAttrValue()
           
 java.lang.String getBaseAttrName()
           
 Key getEntityKey()
          Returns the key for the entity that raised this exception This key remains unchanged when doEntityToVOMapping is called.
 java.lang.String getObjName()
           
 int getObjType()
           
 java.lang.String getObjTypeName()
           
 Key getRowKey()
          Returns the key for the row that raised this exception This key will be an entity key until doEntityToVOMapping is called on this object, when it returns a mapped VO row key.
protected  void init(int objType, java.lang.String objFullName, java.lang.String attrName)
           
protected  void setMappedParameters(ViewObject vo, java.lang.String[] attrNames)
           
 void setObjInfo(int objType, java.lang.String fullName)
          Used internally in the framework
 void setRowDefFullName(java.lang.String objFullName)
           
 void setRowKey(int objType, Key key)
          Advanced :For Internal use only.
 
Methods inherited from class oracle.jbo.ValidationException
getRowDefFullName, hasAttributeException, raise, raise, raise, raiseWithNamedParameters, setErrorParameters, setErrorParametersMap
 
Methods inherited from class oracle.jbo.JboException
addToDetails, addToExceptions, containsException, getExceptions, hasPeerExceptions, needsEntityToVOMapping, printStackTrace, printStackTrace, printStackTrace, setApplicationModule, setDetails, setExceptions, setNeedsEntityToVOMapping
 
Methods inherited from class oracle.jbo.JboWarning
getBaseMessage, getDetailMessage, getDetails, getErrorCode, getErrorParameters, getErrorParametersMap, getJboExceptionHelper, getLocalizedBaseMessage, getLocalizedMessage, getMessage, getProductCode, getProperties, getProperty, getProperty, getResourceClass, getResourceName, getSeverity, getSource, getTypeNameFromId, isAppendCodes, isExceptionInNonUIContext, isLocalizable, isWarning, refreshProperty, setAppendCodes, setLocaleContext, setProperty, setSeverity, setSource
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

mAttrValue

protected java.lang.Object mAttrValue
Constructor Detail

AttrValException

public AttrValException(java.lang.Class resBundleClass,
                        java.lang.String errorCode,
                        java.lang.String defName,
                        java.lang.String attrName,
                        java.lang.Object value,
                        java.util.ArrayList exceptions,
                        boolean hasPeer)
Creates a localizable exception for an object. Message parameters can also be accessed through 'get' methods.

Parameters:
resBundleClass - a resource bundle.
errorCode - an error or message code.
defName - the name of the object, the second message parameter.
attrName - the name of the attribute, the third message parameter.

AttrValException

public AttrValException(java.lang.Class resBundleClass,
                        java.lang.String errorCode,
                        java.lang.String defName,
                        java.lang.String attrName,
                        java.lang.Object value,
                        java.util.ArrayList exceptions)
Creates a localizable exception for an object. Message parameters can also be accessed through 'get' methods.

Parameters:
resBundleClass - a resource bundle.
errorCode - an error or message code.
defName - the name of the object, the second message parameter.
attrName - the name of the attribute, the third message parameter.

AttrValException

public AttrValException(int objType,
                        java.lang.Class resBundleClass,
                        java.lang.String errorCode,
                        java.lang.String objFullName,
                        java.lang.String attrName)
Creates a localizable exception for an object. Message parameters can also be accessed through 'get' methods.

Parameters:
objType - the type of the object, the first message parameter.
resBundleClass - a resource bundle.
errorCode - an error or message code.
objFullName - the name of the object, the second message parameter.
attrName - the name of the attribute, the third message parameter.

AttrValException

public AttrValException(int objType,
                        ResourceBundleDef resBundleDef,
                        java.lang.String errorCode,
                        java.lang.String objFullName,
                        java.lang.String attrName)
Creates a localizable exception for an object. Message parameters can also be accessed through 'get' methods.

Parameters:
objType - the type of the object, the first message parameter.
resBundleDef - a ResourceBundleDef.
errorCode - an error or message code.
objFullName - the name of the object, the second message parameter.
attrName - the name of the attribute, the third message parameter.

AttrValException

public AttrValException(int objType,
                        java.lang.Class resBundleClass,
                        java.lang.String errorCode,
                        java.lang.String objFullName,
                        java.lang.String attrName,
                        java.lang.Object value,
                        java.lang.Exception[] peerExceptions,
                        boolean peer)
Creates a localizable exception for an object. Message parameters can also be accessed through 'get' methods.

Parameters:
objType - the type of the object, the first message parameter.
resBundleClass - a resource bundle.
errorCode - an error or message code.
objFullName - the name of the object, the second message parameter.
attrName - the name of the attribute, the third message parameter.
peerExceptions - Exceptions to store with this exception's details
peer - Mark this exception as containing peer Exceptions.

AttrValException

public AttrValException(int objType,
                        ResourceBundleDef resBundleDef,
                        java.lang.String errorCode,
                        java.lang.String objFullName,
                        java.lang.String attrName,
                        java.lang.Object value,
                        java.lang.Exception[] peerExceptions,
                        boolean peer)
Creates a localizable exception for an object. Message parameters can also be accessed through 'get' methods.

Parameters:
objType - the type of the object, the first message parameter.
resBundleDef - a ResourceBundleDef.
errorCode - an error or message code.
objFullName - the name of the object, the second message parameter.
attrName - the name of the attribute, the third message parameter.
peerExceptions - Exceptions to store with this exception's details
peer - Mark this exception as containing peer Exceptions.

AttrValException

public AttrValException(int objType,
                        java.lang.String msg,
                        java.lang.String errorCode,
                        java.lang.String objFullName,
                        java.lang.String attrName)
Creates a non-localizable exception for an object. Message parameters can also be accessed through 'get' methods.

Parameters:
objType - the type of the object, the first message parameter.
msg - non-localizable text.
errorCode - an error or message code.
objFullName - the name of the object, the second message parameter.
attrName - the name of the attribute, the third message parameter.

AttrValException

protected AttrValException(java.lang.Class resBundleClass,
                           java.lang.String errorCode,
                           java.lang.Object[] params)
Creates a localizable exception for an object. Message parameters can also be accessed through 'get' methods.

Parameters:
resBundleClass - the resource bundle class that contains the message.
errorCode - an error code.
params - the error message's parameters.
Method Detail

init

protected void init(int objType,
                    java.lang.String objFullName,
                    java.lang.String attrName)

setObjInfo

public void setObjInfo(int objType,
                       java.lang.String fullName)
Used internally in the framework


getObjType

public int getObjType()

getObjTypeName

public java.lang.String getObjTypeName()

getObjName

public java.lang.String getObjName()

getAttrValue

public java.lang.Object getAttrValue()

setRowDefFullName

public void setRowDefFullName(java.lang.String objFullName)
Overrides:
setRowDefFullName in class ValidationException

getAttrName

public java.lang.String getAttrName()

getAttributeException

public ValidationException getAttributeException(java.lang.String rowDefName,
                                                 java.lang.String voAttrName)
Overrides:
getAttributeException in class ValidationException
Parameters:
rowDefName - Entity Definition name. If null only attribute name is matched.
voAttrName - return if this exception or one of it's details has mapping attribute name.

doEntityToVOMapping

public void doEntityToVOMapping(ApplicationModule rootAm,
                                ViewObject[] vos)
Overrides:
doEntityToVOMapping in class JboException

setMappedParameters

protected void setMappedParameters(ViewObject vo,
                                   java.lang.String[] attrNames)

getBaseAttrName

public java.lang.String getBaseAttrName()

getRowKey

public Key getRowKey()
Returns the key for the row that raised this exception This key will be an entity key until doEntityToVOMapping is called on this object, when it returns a mapped VO row key.


getEntityKey

public Key getEntityKey()
Returns the key for the entity that raised this exception This key remains unchanged when doEntityToVOMapping is called.


setRowKey

public void setRowKey(int objType,
                      Key key)
Advanced :For Internal use only. Set the key for the object that raised this exception.


equals

public boolean equals(java.lang.Object theOther)
Overrides:
equals in class java.lang.Object

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.0.0)

E17483-01

Copyright © 1997, 2011, Oracle. All rights reserved.