Package com.mycompany.myproject.capi
Class MyFunctionRequest
- java.lang.Object
-
- org.xins.client.AbstractCAPICallRequest
-
- com.mycompany.myproject.capi.MyFunctionRequest
-
- All Implemented Interfaces:
java.io.Serializable
public final class MyFunctionRequest extends AbstractCAPICallRequest
Request for a call to the MyFunction function.An instance of this class is accepted by the corresponding call method in the CAPI class:
CAPI.callMyFunction(MyFunctionRequest)
.- See Also:
CAPI
,MyFunctionResult
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description MyFunctionRequest()
Constructs a newMyFunctionRequest
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UnacceptableRequestException
checkParameters()
Validates whether this request is considered acceptable.Gender.Item
getGender()
Gets the value of the gender parameter.java.lang.String
getPersonLastName()
Gets the value of the personLastName parameter.void
setGender(Gender.Item gender)
Sets or resets the gender parameter as acom.mycompany.myproject.types.Gender.Item
.void
setPersonLastName(java.lang.String personLastName)
Sets or resets the personLastName parameter as aString
.-
Methods inherited from class org.xins.client.AbstractCAPICallRequest
configuration, configure, equals, functionName, hashCode
-
-
-
-
Method Detail
-
getGender
public Gender.Item getGender()
Gets the value of the gender parameter. If unset,null
is returned.- Returns:
- the value of the parameter, or
null
if unset.
-
setGender
public void setGender(Gender.Item gender)
Sets or resets the gender parameter as acom.mycompany.myproject.types.Gender.Item
.- Parameters:
gender
- the new value for the parameter, ornull
if it should be reset.
-
getPersonLastName
public java.lang.String getPersonLastName()
Gets the value of the personLastName parameter. If unset,null
is returned.- Returns:
- the value of the parameter, or
null
if unset.
-
setPersonLastName
public void setPersonLastName(java.lang.String personLastName)
Sets or resets the personLastName parameter as aString
.- Parameters:
personLastName
- the new value for the parameter, ornull
if it should be reset.
-
checkParameters
public UnacceptableRequestException checkParameters()
Validates whether this request is considered acceptable. If any constraints are violated, then anUnacceptableRequestException
is returned.This method is called automatically when this request is executed, so it typically does not need to be called manually in advance.
- Specified by:
checkParameters
in classAbstractCAPICallRequest
- Returns:
- an
UnacceptableRequestException
instance if this request is considered unacceptable, otherwisenull
.
-
-