Notation conventions for methods

The syntax for each Janus SOAP method is displayed in the form of a usage statement which shows how you specify a typical invocation of the method (and receive its result, if any). The syntax includes:

• Keywords and placeholder words
• Punctuation literals (parentheses, colons, etc. that you must specify)
• Special characters (square brackets, hyphens) that you do not specify because they are part of the syntax structure, not the method content

For example, here is the syntax for the Update method of the StringList class:

%outList = sl:Update( updList, [%status])

The Updatemethod accepts two arguments, updates the method StringList, and returns the updated version of that StringList.

About the syntax

• Method names are in mixed case with initial and internal capital letters. User Language keywords and variable name references are also in mixed case. This mixed-caseconvention is adhered to in text and syntax; it is not strictly adhered to in code examples. Formore information about mixed-case User Language, see "Mixed-case User Language".

• In syntax, method arguments are required unless otherwise stated. Omitting a mandatory argumentresults in a compilation error. Optional arguments are enclosed in brackets ([]) in syntax and are described in text with the word "optional."

• Some method arguments may be passed by name; they are specified with a following equal sign (=) in method syntax diagrams. For arguments described as name allowed (or name required), you may specify (or must specify) the argument name along with the argument value when you invoke the method. You specify such argument name and value pairs in the form:

  methodname( argName=argValue )

  Whether an argument name is a "named parameter" is declared for the method within the class definition with the NameAllowed or NameRequired keyword.

• Many functions that return a result may also be invoked by the keyword Call. The descriptions of such functions say that they are callable and display a bracketed %variable and equals sign in syntax. For example:

  [%number =] sl:Add( itemList)

  The Call keyword is almost always optional, so a callable method can usually be invoked by simply specifying the method object followed by colon (:) and the method name:

  Call %sl:Add('the end')

• Methods are non-shared unless otherwise identified. A shared method is recognizable by the %(classname): notation preceding the method name in the method syntax, which implies that the method need not operate on a particular object. For example:

  %max = %(Stringlist):MaxItemLength

  Using the class name in this way denotes that the method is shared, and it models one way you can invoke the method. You can also invoke shared methods using the %objectVariable: notation used by non-shared, or instance, methods. For example, if %sl is a Stringlist object, the following statement assigns the same value to %max as in the preceding example statement:

  %max = %sl:MaxItemLength

  In this case, %sl indicates the class to which the method belongs, not that the method operates on %sl (which may even be null for a shared method invocation).