InvalidSortSpecification class: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 44: Line 44:
This [[Notation conventions for methods|callable]] constructor generates an instance of an <var>InvalidSortSpecification</var> exception. The <var>New</var> constructor format follows:
This [[Notation conventions for methods|callable]] constructor generates an instance of an <var>InvalidSortSpecification</var> exception. The <var>New</var> constructor format follows:
   
   
<h3>Syntax</h3>
<h4>Syntax</h4>
{{Template:InvalidSortSpecification:New syntax}}
{{Template:InvalidSortSpecification:New syntax}}
<h4>Syntax terms</h4>
<h4>Syntax terms</h4>

Revision as of 21:26, 9 June 2011


An InvalidSortSpecification exception indicates that the first argument provided to either the Sort or SortNew method (in the Stringlist class) is not a valid sort specification.

This exception class has no properties. The class's only method is the New constructor, which you would typically use with a User Language Throw statement to produce an InvalidSortSpecification exception. For example:

throw %(invalidSortSpecification):new

Remember that catching an exception is done with the Catch statement; if an exception condition occurs outside a Catch for it, the request is cancelled.

Actually, the InvalidSortSpecification is rarely used. One possible occasion for using it would be a sort specification entered (at least in part) by an end user. In this case, a try.../catch invalidSortSpecification block might be appropriate:

%sortSpec = $read('Enter sort specification') try %strlist:sort(%sortSpec) catch invalidSortSpecification Print 'Invalid ...' ... end try

In most cases, however, a sort specification is explicitly coded in the User Language request (for example, rather than %sortSpec = $read... as above, something like %sortSpec = '1,10,CH,A'). Such a sort specification should be correct in all circumstances, and if it is not, request cancellation (not a try.../catch block) is the appropriate action.

The InvalidSortSpecification class is available as of version 7.9.


The InvalidSortSpecification methods

The following are the available InvalidSortSpecification class methods.

MethodDescription
NewCreate a new InvalidSortSpecification object

The methods in the class are described in the subsections that follow. In addition:


New constructor

Create a new InvalidSortSpecification object (InvalidSortSpecification class)

[Introduced in Sirius Mods 7.9]

This callable constructor generates an instance of an InvalidSortSpecification exception. The New constructor format follows:

Syntax

%invalidSortSpecification = [%(InvalidSortSpecification):]New

Syntax terms

%invalidSortSpecification An InvalidSortSpecification %variable which will refer to the newly created object.
%(InvalidSortSpecification)The class name in parentheses denotes a shared method. New can also be invoked via an InvalidSortSpecification object variable.