Developer Documentation


The OperationInfo structure contains metamodel information of an operation element.


Required Property Name Type Description
required documentation string

English language documentation for the service element. It can contain HTML markup and Javadoc tags.

required errors array of MetamodelErrorInfo

List of error elements that might be reported by the operation element. If the operation reports the same error for more than one reason, the list contains the error element associated with the error more than once with different documentation elements.

required metadata map of MetamodelElementMap

Generic metadata elements for the operation element. The key in the map is the name of the metadata element and the value is the data associated with that metadata element. The MetadataIdentifier contains possible string values for key in the map.

required name string

Name of the operation element in a canonical format. The format is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.

required output MetamodelOperationResultInfo

Metamodel type for the output element.

required params array of MetamodelFieldInfo

Metamodel information for the parameter elements. The order of the parameters elements in the list is same as the order of the parameters declared in the interface definition file.


Was this page helpful?