# apiOperationDefItem

The <apiOperationDefItem> element is the specialization of the <apiDefItem> element to support classifier references and to distinguish returns, parameters, and events.

#### Description

In the <apiOperationDefItem> element, the <state>, <keyword>, and <ph> elements are provided to support unexpected situations within the general representation and to provide a basis for specialization. The <apiOperationDefItem> element is for nested substructure within returns, parameters, and events.

#### Contained by

apiConstructorDef, apiEvent, apiOperationDef, apiOperationDefItem, apiParam, apiReturn

#### Contains

apiArray, apiData, apiDefNote, apiItemName, apiname, apiOperationClassifier, apiOperationDefItem, apiQualifier, apiRelation, apiType, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

#### Content model

(apiItemName or apiOperationClassifier or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiOperationDefItem) (any number)

#### Inheritance

topic/ph reference/ph apiRef/apiDefItem

- apiItemName
  The <apiItemName> element provides the name for substructure of an interface such as parameter of an operation or subfield of a method.
- apiOperationClassifier
  The <apiOperationClassifier> element identifies a returned value that is an instance of a classifier, for example, the class of the returned object.
- apiQualifier
  The <apiQualifier> element specifies a semantic flag that qualifies the interface.
- apiRelation
  The <apiRelation> element specifies a related API item that is part of the declared interface to this API item.
- apiType
  The <apiType> element specifies a type defined by the language itself that is part of the declared interface to this API item.
- apiArray
  The <apiArray> element specifies any type parts, classifier or data within an interface where required.
- apiData
  The <apiData> element specifies the actual value such as the initial value of variable, the default value of a parameter, or the value of a constant.
- apiDefNote
  The <apiDefNote> element provides an optional note element to expand the information about a part of the declared interface for the API item within the <apiDef> element.
- apiDefItem
  The <apiDefItem> element provides the most general definition of an API item when an API interface has subordinate structure such as parameters of a method or subfields of a record value.
- apiOperationDefItem
  The <apiOperationDefItem> element is the specialization of the <apiDefItem> element to support classifier references and to distinguish returns, parameters, and events.
- apiDef
  The <apiDef> element provides the most general representation of the declared syntax.

Parent topic: apiReturn
Parent topic: apiParam
Parent topic: apiEvent
Parent topic: apiOperationDef
Parent topic: apiOperationDefItem
Parent topic: apiConstructorDef