VCSSL/VNANO PLUGIN INTERFACE SPECIFICATION

# String Scalar Data Accessor Interface 1 (String SDAI1)
Specification Document
(org.vcssl.connect.StringScalarDataAccessorInterface1)

## Abstract

String Scalar Data Accessor Interface 1 (String SDAI1) is a data-I/O interface, mainly implemented by data container objects of language processor systems.

In this org.vcssl.connect package, multiple data I/O interfaces are provided for passing/receiving data without any data-conversions, between script-engine-side and plug-in-side, if required.

In them, this interface String SDAI1 provides I/O methods of a String-type scalar value.

## Status

The status of this interface is "FINALIZED".

The specification of this interface had been finalized at 2022/08/31. No modifications will be applied for this interface, excluding documents/comments.

This interface is currently supported by the scripting engine of Vnano. You can use this interface for development of plug-ins of applications equipped with the Vnano engine.

## License

This interface is published under CC0, which is almost the same as the so-called "copyright-free" (domain).

## List of Fields/Methods

INTERFACE_TYPE_ID
  The type ID of this interface (value: "STRING_SDAI") referred when the plug-in will be loaded.
INTERFACE_GENERATION
  The generation of this interface (value: "1").
void setStringScalarData(String data)
  Sets the String-type scalar value.
String getStringScalarData()
  Gets the String-type scalar value.
boolean hasStringScalarData()
  Returns whether any String-type scalar value can be gotten.

## Fields

Name | INTERFACE_TYPE_ID
--- | ---
Value | The type ID of this interface (value: "STRING_SDAI") referred when the plug-in will be loaded.
Type | static final String

Name | INTERFACE_GENERATION
--- | ---
Value | The generation of this interface (value: "1").
Type | static final String

## Methods

Name | setStringScalarData
Signature | void setStringScalarData(String data)
Description | Sets the String-type scalar value.
Parameters | data: The scalar value to be set.
Return | None

Name | getStringScalarData
Signature | String getStringScalarData()
Description | Gets the String-type scalar value.
Parameters | None
Return | The scalar value.

Name | hasStringScalarData
Signature | boolean hasStringScalarData()
Description | Returns whether any String-type scalar value can be gotten.
Parameters | None
Return | Returns true if any String-type scalar value can be gotton.