|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.lang.Throwable java.lang.Exception org.xins.common.service.CallException org.xins.client.XINSCallException org.xins.client.UnacceptableMessageException
Exception that indicates that a request for an API call is considered unacceptable on the application-level. For example, a mandatory input parameter may be missing.
Constructor Summary | |
UnacceptableMessageException(XINSCallResult result)
Constructs a new UnacceptableMessageException using the
specified XINSCallResult .
|
Method Summary | |
void |
addAttributeCombo(String type,
List attributes,
String elementName)
Adds an invalid combination of attributes. |
void |
addInvalidValueForType(String parameter,
String type)
Deprecated. since XINS 2.0, use addInvalidValueForType(String, String, String) . |
void |
addInvalidValueForType(String parameter,
String value,
String type)
Adds an invalid value for a specified type. |
void |
addInvalidValueForType(String parameter,
String value,
String type,
String element)
Adds an invalid value for a specified type. |
void |
addMissingParameter(String parameter)
Adds to the response that a paramater that is missing. |
void |
addMissingParameter(String parameter,
String element)
Adds to the response a parameter that is missing in an element. |
void |
addParamCombo(String type,
List parameters)
Adds an invalid combination of parameters. |
String |
getMessage()
Returns the message for this exception. |
Methods inherited from class org.xins.common.service.CallException |
getDetail, getDuration, getNext, getRequest, getTarget, isFailOverAllowed |
Methods inherited from class java.lang.Throwable |
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public UnacceptableMessageException(XINSCallResult result)
UnacceptableMessageException
using the
specified XINSCallResult
.
This constructor is used by the generated CAPI.
result
- the XINSCallResult
that is considered unacceptable,
cannot be null
.Method Detail |
public String getMessage()
getMessage
in class CallException
null
.public void addMissingParameter(String parameter)
parameter
- the missing parameter.public void addMissingParameter(String parameter, String element)
parameter
- the missing parameter.element
- the element in which the parameter is missing.public void addInvalidValueForType(String parameter, String type)
addInvalidValueForType(String, String, String)
.
parameter
- the name of the parameter passed by the user.type
- the type which this parameter should be compliant with.public void addInvalidValueForType(String parameter, String value, String type)
parameter
- the name of the parameter passed by the user.value
- the value of the parameter passed by the user.type
- the type which this parameter should be compliant with.public void addInvalidValueForType(String parameter, String value, String type, String element)
parameter
- the parameter passed by the user.value
- the value of the parameter passed by the user.type
- the type which this parameter should be compliant with.element
- the element in which the parameter is missing.public void addParamCombo(String type, List parameters)
type
- the type of the combination.parameters
- list of the parameters in the combination passed as a list of
String
objects.public void addAttributeCombo(String type, List attributes, String elementName)
type
- the type of the combination.attributes
- list of the attributes in the combination passed as a list of
String
objects.elementName
- the name of the element to which these attributes belong.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |