C F G L M N S

C

CAPI - class com.mycompany.myproject.capi.CAPI.

Stub for the myproject API.

CAPI(PropertyReader) - Constructor for class com.mycompany.myproject.capi.CAPI

Constructs a new CAPI object for the specified API from a set of properties.

CAPI(PropertyReader, String) - Constructor for class com.mycompany.myproject.capi.CAPI

Constructs a new CAPI object for the specified API from a set of properties, specifying the API name to assume.

CAPI(Descriptor) - Constructor for class com.mycompany.myproject.capi.CAPI

Constructs a new CAPI object, using the specified Descriptor.

callMyFunction(MyFunctionRequest) - Method in class com.mycompany.myproject.capi.CAPI

Calls the MyFunction function using the specified request object.

callMyFunction(Gender.Item, String) - Method in class com.mycompany.myproject.capi.CAPI

Calls the MyFunction function with the specified parameters.

checkParameters() - Method in class com.mycompany.myproject.capi.MyFunctionRequest

Validates whether this request is considered acceptable.

com.mycompany.myproject.capi - package com.mycompany.myproject.capi

Client-side calling interface (CAPI) for the myproject API.

com.mycompany.myproject.types - package com.mycompany.myproject.types

Types defined in the myproject API.

F

FEMALE - Static variable in class com.mycompany.myproject.types.Gender

The female item.

fromStringForOptional(String) - Static method in class com.mycompany.myproject.types.Gender

fromStringForOptional(String) - Static method in class com.mycompany.myproject.types.LastName

Converts the specified character string -or null- to a value for this type.

fromStringForRequired(String) - Static method in class com.mycompany.myproject.types.Gender

fromStringForRequired(String) - Static method in class com.mycompany.myproject.types.LastName

Converts the specified character string to a value for this type.

fromStringImpl(String) - Method in class com.mycompany.myproject.types.Gender

G

Gender - class com.mycompany.myproject.types.Gender.

Enum type Gender.

Gender.Item - class com.mycompany.myproject.types.Gender.Item.

Item of the Gender enumeration type.

getGender() - Method in class com.mycompany.myproject.capi.MyFunctionRequest

Gets the value of the gender parameter.

getItemByName(String) - Static method in class com.mycompany.myproject.types.Gender

Gets the Item for the specified string name.

getItemByValue(String) - Static method in class com.mycompany.myproject.types.Gender

Gets the Item for the specified string value.

getMessage() - Method in class com.mycompany.myproject.capi.MyFunctionResult

Gets the value of the required output parameter message.

getPersonLastName() - Method in class com.mycompany.myproject.capi.MyFunctionRequest

Gets the value of the personLastName parameter.

getXINSVersion() - Method in class com.mycompany.myproject.capi.CAPI

Returns the version of XINS used to generate this CAPI class.

L

LastName - class com.mycompany.myproject.types.LastName.

Pattern type LastName.

M

MALE - Static variable in class com.mycompany.myproject.types.Gender

The male item.

MyFunctionRequest - class com.mycompany.myproject.capi.MyFunctionRequest.

Request for a call to the MyFunction function.

MyFunctionRequest() - Constructor for class com.mycompany.myproject.capi.MyFunctionRequest

Constructs a new MyFunctionRequest instance.

MyFunctionResult - class com.mycompany.myproject.capi.MyFunctionResult.

Result of a call to the MyFunction function.

N

NoVowelException - exception com.mycompany.myproject.capi.NoVowelException.

Exception that represents the NoVowel error code.

NoVowelException(XINSCallRequest, TargetDescriptor, long, XINSCallResultData) - Constructor for class com.mycompany.myproject.capi.NoVowelException

Constructs a new NoVowelException instance.

S

SINGLETON - Static variable in class com.mycompany.myproject.types.Gender

The only instance of this class.

SINGLETON - Static variable in class com.mycompany.myproject.types.LastName

The only instance of this class.

setGender(Gender.Item) - Method in class com.mycompany.myproject.capi.MyFunctionRequest

Sets or resets the gender parameter as a com.mycompany.myproject.types.Gender.Item.

setPersonLastName(String) - Method in class com.mycompany.myproject.capi.MyFunctionRequest

Sets or resets the personLastName parameter as a String.

C F G L M N S