apiOperationClassifier

The <apiOperationClassifier> element identifies a returned value that is an instance of a classifier, for example, the class of the returned object.

Description

The <apiOperationClassifier> is not restricted to the type of return values; it can be the type of a parameter or event. It is a return value only when it appears within <apiReturn>. This element can provide an href attribute if the description of the API item is available. If the description is not available, the <apiOperationClassifier> element can provide the name of the API item in its contents.

Example

The following example shows an <apiOperationClassifier> item for a Visual Basic method:

<apiOperation id="rational.xde.getApplicableStereotypesAsString">
   <apiName>getApplicableStereotypesAsString</apiName>
   <shortDesc>Returns a string that specifies the stereotype associated with the element.</shortDesc>
   <apiOperationDetail>
     <apiOperationDef>
      <apiImpl>Method</apiImpl>
          <apiType name="type" value="Function"/>
          <apiQualifier name="access" value="public"/>
          <apiOperationClassifier href=”String.dita”>String</apiOperationClassifier>
          <apiDefNote>Returns a string that specifies the stereotypes.</apiDefNote>
      </apiOperationDef>
      <apiDesc>This property searches all the profiles in the model.</apiDesc>
    </apiOperationDetail>
 </apiOperation>

Contained by

apiConstructorDef, apiEvent, apiOperationDef, apiOperationDefItem, apiParam, apiReturn

Content model

(text data) (any number)

Inheritance

topic/xref reference/xref apiRef/apiRelation