Web services Java and LotusScript classes

The Domino and Domino Designer release of Web services includes an inventory of predefined LotusScript and Java classes used for mapping to WSDL XML Schema types.

LotusScript Web services classes

The LotusScript Web service mapping classes are exposed for users in the LSXSD.LSS file, supplied in the binaries directory of a Notes or Domino installation.

Public classes:

INOUT_HOLDER

The root "holder" class, used to indicate that some subtype, when appearing as a Web service method parameter type, is an input/output parameter for the method.

LS_PROXY_OBJECT

The root "proxy" class, used to provide a common, string-based interface for all classes mapped to some XSD data type.

methods:

SUB setValueFromString (value As String)

Accepts a value appropriate for an instance of each mapped subclass; Valueshould conform to the XML Schema lexical representation specified for each mapped subclass.

FUNCTION getValueAsString () As String

Returns the current value for an instance of each mapped subclass; the returned value should conform to the XML Schema lexical representation specified for the mapped subclass.

WS_FAULT

The root fault class, used to provide a common interface for setting a fault in a Web service method, and specifying the returned SOAP 1.1 faultString property.

methods:

SUB setFault (value As BOOLEAN)

Sets the current state of the fault. A "true" state means the fault is set, and should be returned as the response for the invoked Web service method. Upon method invocation, the default state for all fauls is "false".

FUNCTION getFault () As BOOLEAN

Gets the current state of the fault.

SUB setFaultString (value As STRING)

Sets the SOAP 1.1 faultString property, to be returned with a fault response whose state is "true".

FUNCTION getFaultString () As STRING

Gets the current SOAP 1.1 faultString property.

SUB setFaultCode (value As STRING)

New with release 8.0. Sets the code value for the SOAP 1.1 <faultcode> subelement on the returned SOAP fault (the full SOAP 1.1 faultcode is always a qualified name, namespace "http://schemas.xmlsosap.org/soap/envelope"). The default faultcode value is "Server".

FUNCTION getFaultCode () As STRING

New with release 8.0. Gets the code value for the SOAP 1.1 <faultcode> subelement on the returned SOAP fault (local part, only, of the qualified name)

SUB setFaultActor (value As String)

New with release 8.0. Sets the value for the SOAP 1.1 <faultactor> subelement on the returned SOAP fault.

FUNCTION getFaultActor () As STRING

New with release 8.0. Gets the value for the SOAP 1.1 <faultactor> subelement on the returned SOAP fault.

SUB setFaultDetails (value() as NOTESDOMELEMENTNODE)

New with release 8.0. Adds the content of the NOTESDOMELEMENTNODE array argument to become the subelement(s) and value(s) for the SOAP 1.1 <detail> subelement on the returned SOAP fault. Clears any current details content for the Fault.

FUNCTION getFaultDetails () As NOTESDOMELEMENTNODEARRAY_HOLDER

New with release 8.0. Gets the subelement(s) and value(s) for the SOAP 1.1 <detail> subelement on the returned SOAP fault, as the NOTESDOMELEMENTNODE array value for the returned NOTESDOMELEMENTNODEARRAY_HOLDER object.

usage:

Implict faults: a service method argument directly typed "as WS_FAULT" has no visibility in the corresponding WSDL document, and so is implicit to the WSDL contract. These may be added or subtracted from any LotusScript Web service method without impacting the associated WSDL contract, e.g:

       Sub setMyData( foo as String, fault as WS_FAULT )

Explicit faults: a service method argument may also be typed as a user-defined class that in turn inherits from WS_FAULT. Here, such a user-defined class and its public members will be visibly present (explicit) in the WSDL document, typically as a complexType for defining some WSDL operation <fault> element. Adding or subtracting explicit faults from any LotusScript Web service method represents a change to the WSDL contract, and will result in regenerating the associated WSDL document for the Web service upon saving the service design element, e.g:

       Sub setMyData( foo as String, fault as ALL_MY_FAULT)

where class ALL_MY_FAULT is defined elsewhere as:

       Publc class ALL_MY_FAULT As WS_FAULT

Note: Faults for a LotusScript service method must appear at the end of the method argument list (any WS_FAULT base class or its subclasses).

XSD_ANYTYPE

The proxy class mapped to XML Schema type anyType, the root class for all XML Schema built-in types.

Super class:

LS_PROXY_OBJECT

Inherited methods:

SUB setValueFromString (value As String)
FUNCTION getValueAsString () As String

XSD_ANYURI

The proxy class mapped to XML Schema type anyURI. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_BASE64BINARY

The proxy class mapped to XML Schema type base64Binary. Nillable.

Super class:

XSD_SIMPLETYPE

methods:

SUB setValueFromNotesStream (nsValue As NotesStream)

Sets the XML representation by converting bytes in the NoteStream to a base64-encoded string.

FUNCTION getValueAsNotesStream () As NotesStream

Converts the current base64-encoded XML representation to bytes in the returned NotesStream.

Inherited methods:

SUB setValueFromString (value As String)

Sets the current value from a string of base64-encoded characters

FUNCTION getValueAsString () As String

Returns the current value of base64-encoded characters.

XSD_BOOLEAN

The proxy class mapped to XML Schema type boolean. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object ("true" or "false")

FUNCTION getValueAsString () As String

Returns the XML representation of the object ("true" or "false")

XSD_BYTE

The proxy class mapped to XML Schema type byte. Nillable.

Super class:

XSD_SHORT

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_DATE

The proxy class mapped to XML Schema type date. Nillable.

Super class:

XSD_SIMPLETYPE

methods:

SUB SetValueFromNotesDateTime (value As NotesDateTime)

Sets the XML representation of the object from the NotesDateTime object. Any time zone information is ignored.

SUB SetValueWithZoneFromNotesDateTime (value As NotesDateTime)

New with release 8.0. Sets the XML representation of the object from the NotesDateTime object, including any time zone information.

Function GetValueAsNotesDateTime ( ) As NotesDateTime

Returns the XML representation of the object as a NotesDateTime object. Any time zone information is ignored.

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_DATETIME

The proxy class mapped to XML Schema type dateTime. Nillable.

Super class:

XSD_SIMPLETYPE

methods:

SUB SetValueFromNotesDateTime (value As NotesDateTime)

Sets the XML representation of the object from the NotesDateTime object. Any time zone information is ignored.

SUB SetValueWithZoneFromNotesDateTime (value As NotesDateTime)

New with release 8.0. Sets the XML representation of the object from the NotesDateTime object, including any time zone information.

Function GetValueAsNotesDateTime ( ) As NotesDateTime

Returns the XML representation of the object as a NotesDateTime object. Any time zone information is ignored.

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_DECIMAL

The proxy class mapped to XML Schema type decimal. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_DOUBLE

The proxy class mapped to XML Schema type double. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_DURATION

The proxy class mapped to XML Schema type duration Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_ENTITY

The proxy class mapped to XML Schema type ENTITY. Nillable.

Super class:

XSD_NCNAME

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_ENTITIES

The proxy class mapped to XML Schema type ENTITIES. Nillable.

Super class:

XSD_LIST

public members:

PUBLIC theList () As XSD_ENTITY

methods:

SUB initListItem (idx As INTEGER)

Initializes the idx'th element of the list to a new XSD_IDREF, if nothing.

SUB setListValueFromString (idx As INTEGER, value As STRING)

Sets the XML representation of the idx'th XSD_IDREF element in the list.

FUNCTION getListValueAsString (idx As INTEGER) As STRING

Returns the XML representation of the idx'th XSD_IDREF element in the list.

FUNCTION getListLength () As INTEGER

Returns the current size of the list.

Inherited methods:

SUB setValueFromString (value As String)

Not useful.

FUNCTION getValueAsString () As String

Not useful.

XSD_FLOAT

The proxy class mapped to XML Schema type float. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_GDAY

The proxy class mapped to XML Schema type gDay. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object. An XML gDay representation includes a valid day of the month in XML Schema left-truncated date form, that is, - - - D D (three dashes followed by two digits), followed by an optional time zone expression, that is, either Z for Coordinated Universal Time (UCT), or + or - (plus or minus) followed by hh:mm as the +/- hours:minutes offset from UCT.

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_GMONTH

The proxy class mapped to XML Schema type gMonth. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object. An XML gMonth representation includes a valid month in left- and right-truncated date form, that is, - - M M - - (two dashes followed by two digits followed by two dashes), followed by an optional time zone expression, that is, either Z for Coordinated Universal Time (UCT), or + or - (plus or minus) followed by hh:mm as the +/- hours:minutes offset from UCT.

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_GMONTHYEAR

The proxy class mapped to XML Schema type gMonthDay. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object. An XML GMonthDay expression includes valid month and day in XML Schema left-truncated date form -- MM-DD (two dashes, followed by two digits, followed by a dash, followed by two digits ), followed by an optional time zone expression, that is, either Z for Coordinated Universal Time (UCT), or + or - (plus or minus) followed by hh:mm as the +/- hours:minutes offset from UCT.

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_GYEAR

The proxy class mapped to XML Schema type gYear. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object. An XML gYear expression includes a valid year in XML Schema right-truncated dateTime form "[-]CCYY" (at least four digits with an optional leading "-" minus sign), followed by an optional time zone expression, i.e. either "Z" for Coordinated Universal Time (UCT), or "+" or "-" (plus or minus) followed by hh:mm as the +/- hours:minutes offset from UCT.

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_GYEAERMONTH

The proxy class mapped to XML Schema type gYearMonth. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object. An XML GYearMonth expression includes a valid year and month in XML Schema right-truncated dateTime form "[-]CCYY - MM" (at least four digits with an optional leading "-" minus sign, followed by a dash, followed by two digits ), followed by an optional time zone expression, i.e. either "Z" for Coordinated Universal Time (UCT), or "+" or "-" (plus or minus) followed by hh:mm as the +/- hours:minutes offset from UCT.

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_HEXBINARY

The proxy class mapped to XML Schema type hexBinary. Nillable.

Super class:

XSD_SIMPLETYPE

methods:

SUB setValueFromNotesStream (nsValue As NotesStream)

Sets the XML representation by converting bytes in the NoteStream to a hexBinary-encoded string.

FUNCTION getValueAsNotesStream () As NotesStream

Converts the current hexBinary-encoded XML representation to bytes in the returned NotesStream.

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation from a string of hexBinary-encoded characters

FUNCTION getValueAsString () As String

Returns the current XML representation of hexBinary-encoded characters.

XSD_ID

The proxy class mapped to XML Schema type ID. Nillable.

Super class:

XSD_NCNAME

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_IDREF

The proxy class mapped to XML Schema type IDREF. Nillable.

Super class:

XSD_NCNAME

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_IDREFS

The proxy class mapped to XML Schema type IDREFS. Nillable.

Super class:

XSD_LIST

public members:

PUBLIC theList () As XSD_IDREF

methods:

SUB initListItem (idx As INTEGER)

Initializes the idx'th element of the list to a new XSD_IDREF, if nothing.

SUB setListValueFromString (idx As INTEGER, value As STRING)

Sets the XML representation of the idx'th XSD_IDREF element in the list.

FUNCTION getListValueAsString (idx As INTEGER) As STRING

Returns the XML representation of the idx'th XSD_IDREF element in the list.

FUNCTION getListLength () As INTEGER

Returns the current size of the list.

Inherited methods:

SUB setValueFromString (value As String)

Not useful.

FUNCTION getValueAsString () As String

Not useful.

XSD_INT

The proxy class mapped to XML Schema type int. Nillable.

Super class:

XSD_LONG

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_INTEGER

The proxy class mapped to XML Schema type integer. Nillable.

Super class:

XSD_DECIMAL

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_LANGUAGE

The proxy class mapped to XML Schema type language. Nillable.

Super class:

XSD_TOKEN

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_LIST

The proxy class mapped to XML Schema type list simple type (not related to the LotusScript list type)

Super class:

XSD_SIMPLETYPE

methods:

FUNCTION getValueAsString () As String

Returns the contents of the list as a sequence of whitespace delimited string tokens.

Inherited methods:

SUB setValueFromString (value As String)

Not useful.

usage:

XSD_LIST is only used as the base class for a user-defined class that implements a specific kind of XML Schema list. To do this, an XSD_LIST subclass must implement the following:

One public array member, whose type maps to any XML Schema simple type, except boolean (e.g. xsd:string, xsd:integer, an enumeration, etc.)
```
       Public value() As ...
```
One private member:
```
       Private initialized As Boolean
```

The following methods:

       Sub setListValueFromString (idx As Integer, value As String)
           If idx < 0 Then Error ErrArgOutOfRange
           If Not initialized Then
               Redim Me.value(0 To idx)
               Let initialized = True
           Else
           If idx > Ubound(Me.value) Then Redim Preserve Me.value(0 To idx)
           End If
           Let Me.value(idx) = Cstr(value)  
                       'cast must produce a value( ) array element type
       End Sub
   
       Function getListValueAsString (idx As Integer) As String
           If Not initialized Then Error ErrArgOutOfRange
           getListValueAsString = Cstr(value(idx))
       End Function
   
       Function getListLength () As Integer	
           If Not initialized Then
               getListLength = 0
           Else
               getListLength = Ubound(value)+1
           End If
       End Function

Note: If the Public value( ) array member type is a mapped simple type class instead of a LotusScript built-in type, then some pattern statements change accordingly. For example, if the array member type is XSD_NCNAME, then in Sub setListValueFromString, the last statement:

       Let Me.value(idx) = Cstr(value)

is replaced by two statements:

       Set Me.value(idx) = New XSD_NCNAME  
                          'creates an instance of the simple type class
       Call Me.value(idx).setValueFromString(value)

Similarly, the last statement in Sub getListValueAsString is replaced by:

       getListValueAsString = value(idx).getValueAsString

XSD_LONG

The proxy class mapped to XML Schema type long. Nillable.

Super class:

XSD_INTEGER

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_NAME

The proxy class mapped to XML Schema type Name. Nillable.

Super class:

XSD_TOKEN

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_NCNAME

The proxy class mapped to XML Schema type NCName. Nillable.

Super class:

XSD_NAME

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_NEGATIVEINTEGER

The proxy class mapped to XML Schema type negativeInteger. Nillable.

Super class:

XSD_NONPOSITIVEINTEGER

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_NMTOKEN

The proxy class mapped to XML Schema type NMTOKEN. Nillable.

Super class:

XSD_TOKEN

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_NMTOKENS

The proxy class mapped to XML Schema type NMTOKENS. Nillable.

Super class:

XSD_LIST

public members:

PUBLIC theList () As XSD_NMTOKEN

methods:

SUB initListItem (idx As INTEGER)

Initializes the idx'th element of the list to a new XSD_IDREF, if nothing.

SUB setListValueFromString (idx As INTEGER, value As STRING)

Sets the XML representation of the idx'th XSD_IDREF element in the list.

FUNCTION getListValueAsString (idx As INTEGER) As STRING

Returns the XML representation of the idx'th XSD_IDREF element in the list.

FUNCTION getListLength () As INTEGER

Returns the current size of the list.

Inherited methods:

SUB setValueFromString (value As String)

Not useful.

FUNCTION getValueAsString () As String

Not useful.

XSD_NONNEGATIVEINTEGER

The proxy class mapped to XML Schema type nonNegativeInteger. Nillable.

Super class:

XSD_INTEGER

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_NONPOSITIVEINTEGER

The proxy class mapped to XML Schema type nonPositiveInteger. Nillable.

Super class:

XSD_INTEGER

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_NORMALIZEDSTRING

The proxy class mapped to XML Schema type normalizedString. Nillable.

Super class:

XSD_STRING

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_NOTATION

The proxy class mapped to XML Schema type NOTATION. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_POSITIVEINTEGER

The proxy class mapped to XML Schema type positiveInteger. Nillable.

Super class:

XSD_NONNEGATIVEINTEGER

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_QNAME

The proxy class mapped to XML Schema type QName. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_SHORT

The proxy class mapped to XML Schema type short. Nillable.

Super class:

XSD_INT

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_SIMPLETYPE

The proxy class corresponding to XML Schema conceptual type anySimpleType, the base type for all XML Schema primitive types.

usage:

Do not use. Not mappable to a conceptual type.

XSD_STRING

The proxy class mapped to XML Schema type string. Nillable.

Super class:

XSD_SIMPLETYPE

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_TIME

The proxy class mapped to XML Schema type time. Nillable.

Super class:

XSD_SIMPLETYPE

methods:

SUB SetValueFromNotesDateTime (value As NotesDateTime)

Sets the XML representation of the object from the NotesDateTime object. Any time zone information is ignored.

SUB SetValueWithZoneFromNotesDateTime (value As NotesDateTime)

New with release 8.0. Sets the XML representation of the object from the NotesDateTime object, including any time zone information.

Function GetValueAsNotesDateTime ( ) As NotesDateTime

Returns the XML representation of the object as a NotesDateTime object. Any time zone information is ignored.

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_TOKEN

The proxy class mapped to XML Schema type token. Nillable.

Super class:

XSD_NORMALIZEDSTRING

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_UNSIGNEDBYTE

The proxy class mapped to XML Schema type unsignedByte. Nillable.

Super class:

XSD_UNSIGNEDSHORT

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_UNSIGNEDINT

The proxy class mapped to XML Schema type unsignedInt. Nillable.

Super class:

XSD_UNSIGNEDLONG

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_UNSIGNEDLONG

The proxy class mapped to XML Schema type unsignedLong. Nillable.

Super class:

XSD_NONNEGATIVEINTEGER

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

XSD_UNSIGNEDSHORT

The proxy class mapped to XML Schema type unsignedShort. Nillable.

Super class:

XSD_UNSIGNEDINT

Inherited methods:

SUB setValueFromString (value As String)

Sets the XML representation of the object

FUNCTION getValueAsString () As String

Returns the XML representation of the object

Helper classes:

These classes are used internally by other LSXSD.LSS classes.

XSD_DATATYPE_CONVERTER

methods:

Function notesStreamToBase64 (ns As NotesStream) As String

Returns the contents of the NotesStream as a string of base64-encoded characters.

Function notesStreamToBase64Ext (ns As NotesStream) As String

New with release 8.0. Same as notesStreamToBase64, but with Domino 8 performance enhancements.

Function base64ToNotesStream (b64String As String) As NotesStream

Decodes the string of base64-encoded characters into a byte array, and returns the byte array as a NotesStream

Function base64ToNotesStreamExt (b64String As String) As NotesStream

New with release 8.0. Same as base64ToNotesStream, but with Domino 8 performance enhancements.

Function notesStreamToHexBinary (ns As NotesStream) As String

Returns the contents of the NotesStream as a string of hexBinary-encoded characters.

Function hexBinaryToNotesStream (hexString As String) As NotesStream

Decodes the string of hexBinary-encoded characters into a byte array, and returns the byte array as a NotesStream

Sub setXSDDate (ndt As NotesDateTime, xsddate As String)

Sets the date part of a NotesDateTime From "CCYY-MM-DD ..."

Function getXSDDate (ndt As NotesDateTime) As String

Returns the date part of a NotesDateTime as "CCYY-MM-DD"

Function getXSDZoneDate (ndt As NotesDateTime) As String

New with release 8.0. Returns the date part of a NotesDateTime as "CCYY-MM-DD" + time zone part

Sub setXSDTime (ndt As NotesDateTime, xsdtime As String)

Sets the time part of a NotesDateTime From "HH:MM:SS ..."

Function getXSDTime (ndt As NotesDateTime) As String

Returns the time part of a NotesDateTime as "HH:MM:SS". Does not compute fractional seconds or time zone information.

Function getXSDZoneTime (ndt As NotesDateTime) As String

New with release 8.0. Returns the time part of a NotesDateTime as "HH:MM:SS", adjusted for time zone. Does not compute fractional seconds.

Function getXSDZone (ndt As NotesDateTime) As String

New with release 8.0. Returns the XSD zone part of a NotesDateTime as "Z" or "+HH:00" or "-HH:00"

Sub setXSDDateTime (ndt As NotesDateTime, source As String)

New with release 8.0. Sets the date, time & zone parts of a NotesDateTime from "CCYY-MM-DDT...Z..." If the zone offset is not supported by the NotesDateTime class, the NotesDateTime zone properties are converted to GMT.

Support routines for setXSDDateTime, new with release 8.0:

Function isDigit(inp as String) As Boolean
Function getZone(zoneoffset As Long, zonemins As Long) As String
Function getMilliseconds(millisecondpart As String) As Long

The following holder classes implement INOUT_HOLDER, and are supplied for passing values of the indicated type:


Holder class	Holds a public value...
BYTE_HOLDER	member of type Byte
BYTEARRAY_HOLDER	array member of type Byte
BOOLEAN_HOLDER	member of type Boolean
BOOLEANARRAY_HOLDER	array member of type Boolean
DOUBLE_HOLDER	member of type Double
DOUBLEARRAY_HOLDER	array member of type Double
INTEGER_HOLDER	member of type Integer
INTEGERARRAY_HOLDER	array member of type Integer
LONG_HOLDER	member of type Long
LONGARRAY_HOLDER	array member of type Long
NOTESDOMELEMENTNODE_HOLDER	member of type NotesDOMElementNode
NOTESDOMELEMENTNODEARRAY_HOLDER	array member of type NotesDOMElementNode
SINGLE_HOLDER	member of type Single
SINGLEARRAY_HOLDER	array member of type Single
STRING_HOLDER	member of type String
STRINGARRAY_HOLDER	array member of type String
VARIANT_HOLDER	member of type Variant
VARIANTARRAY_HOLDER	array member of type Variant
XSD_ANYTYPE_HOLDER	member of type XSD_ANYTYPE
XSD_ANYURI_HOLDER	member of type XSD_ANYURI
XSD_BASE64BINARY_HOLDER	member of type XSD_BASE64BINARY
XSD_BOOLEAN_HOLDER	member of type XSD_BOOLEAN
XSD_BYTE_HOLDER	member of type XSD_BYTE
XSD_DATE_HOLDER	member of type XSD_DATE
XSD_DATETIME_HOLDER	member of type XSD_DATETIME
XSD_DECIMAL_HOLDER	member of type XSD_DECIMAL
XSD_DOUBLE_HOLDER	member of type XSD_DOUBLE
XSD_DURATION_HOLDER	member of type XSD_DURATION
XSD_ENTITY_HOLDER	member of type XSD_ENTITY
XSD_ENTITIES_HOLDER	member of type XSD_ENTITIES
XSD_FLOAT_HOLDER	member of type XSD_FLOAT
XSD_GDAY_HOLDER	member of type XSD_GDAY
XSD_GMONTH_HOLDER	member of type XSD_GMONTH
XSD_GMONTHDAY_HOLDER	member of type XSD_GMONTHDAY
XSD_GYEAR_HOLDER	member of type XSD_GYEAR
XSD_GYEARMONTH_HOLDER	member of type XSD_GYEARMONTH
XSD_HEXBINARY_HOLDER	member of type XSD_HEXBINARY
XSD_ID_HOLDER	member of type XSD_ID
XSD_IDREF_HOLDER	member of type XSD_IDREF
XSD_IDREFS_HOLDER	member of type XSD_IDREFS
XSD_INT_HOLDER	member of type XSD_INT
XSD_INTEGER_HOLDER	member of type XSD_INTEGER
XSD_LANGUAGE_HOLDER	member of type XSD_LANGUAGE
XSD_LIST_HOLDER	member of type XSD_LIST
XSD_LONG_HOLDER	member of type XSD_LONG
XSD_NAME_HOLDER	member of type XSD_NAME
XSD_NCNAME_HOLDER	member of type XSD_NCNAME
XSD_NEGATIVEINTEGER_HOLDER	member of type XSD_NEGATIVEINTEGER
XSD_NMTOKEN_HOLDER	member of type XSD_NMTOKEN
XSD_NMTOKENS_HOLDER	member of type XSD_NMTOKENS
XSD_NONNEGATIVEINTEGER_HOLDER	member of type XSD_NONNEGATIVEINTEGER
XSD_NONPOSITIVEINTEGER_HOLDER	member of type XSD_NONPOSITIVEINTEGER
XSD_NORMALIZEDSTRING_HOLDER	member of type XSD_NORMALIZEDSTRING
XSD_NOTATION_HOLDER	member of type XSD_NOTATION
XSD_POSITIVEINTEGER_HOLDER	member of type XSD_POSITIVEINTEGER
XSD_QNAME_HOLDER	member of type XSD_QNAME
XSD_SHORT_HOLDER	member of type XSD_SHORT
XSD_STRING_HOLDER	member of type XSD_STRING
XSD_TIME_HOLDER	member of type XSD_TIME
XSD_TOKEN_HOLDER	member of type XSD_TOKEN
XSD_UNSIGNEDBYTE_HOLDER	member of type XSD_UNSIGNEDBYTE
XSD_UNSIGNEDINT_HOLDER	member of type XSD_UNSIGNEDINT
XSD_UNSIGNEDLONG_HOLDER	member of type XSD_UNSIGNEDLONG
XSD_UNSIGNEDSHORT_HOLDER	member of type XSD_UNSIGNEDSHORT

Java Web services classes

The Java Web service mapping classes are exposed for users in the lotus.domino.types package of the websvc.jar file, supplied in the binaries directory of a Notes or Domino installation.

Public classes:

Base64Binary

Implementation of XML Schema type base64Binary

constructors:

public Base64Binary()

No-argument (default) constructor -- initializes to zero-length binary

public Base64Binary(String string)

Expects a base64-encoded string argument; stored as decoded binary

public Base64Binary(byte[] bytes)

Expects a binary argument; stored as is

methods:

public byte[] getBytes(){

Returns the binary data as is

public String toString()

Returns the binary data as a base64-encoded string

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method

public static byte[] decode(String string)

Returns a base64-encoded string argument as decoded binary

public static String encode(byte data[])

Returns a binary argument as base64-encoded string

Inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

from java.lang.Throwable:

fillInStackTrace

getLocalizedMessage

getStackTrace

initCause

printStackTrace (3)

setStackTrace

from java.rmi.RemoteException

getMessage

Duration

Implementation of XML Schema type duration

constructors:

public Duration()

No-argument (default) constructor

public Duration(boolean negative, int aYears, int aMonths, int aDays, int aHours, int aMinutes, double aSeconds)

Accepts individual components of an xsd:duration

public Duration(String duration) throws IllegalArgumentException

Expects its String argument to express an xsd:duration value

methods:

public void parseTime(String time)

Parses its String argument for the hours, minutes, and seconds components of an xsd:duration and updates the object accordingly

public void parseDate(String date)

Parses its String argument for the years, months, and days components of an xsd:duration and updates the object accordingly

public String toString()

Returns the XML representation of the xsd:duration object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a component-by-component comparison on the object (e.g. a "1 hour" duration will return false when compared to a "60 minute" duration)

property getters/setters:

   public boolean isNegative()
   public int getYears()
   public int getMonths()
   public int getDays()
   public int getHours()
   public int getMinutes()
   public double getSeconds()
   public void setNegative(boolean negative)
   public void setYears(int years)
   public void setMonths(int months)
   public void setDays(int days)
   public void setHours(int hours)
   public void setMinutes(int minutes)
   public void setSeconds(int seconds)

Inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

Entities

Implementation of XML Schema type entities

constructors:

public Entities()

No-argument (default) constructor

public Entities(String stValue) throws IllegalArgumentException

Parses the String argument for one or more string tokens, stored as the object's list of lotus.domino.types.Entity value(s)

public Entities(Entity[] entValues)

Stores the lotus.domino.types.Entity[ ] argument as the object's list of Entity value(s)

property getters/setters:

   public Entity[] getValue()
   public void setValue(Entity[] entValues)
   public void setValue(String stValue)

Parses the String argument for one or more string tokens, stored as the object's list of lotus.domino.types.Entity value(s)

methods:

public String toString()

Returns the XML representation of the xsd:entities object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations (e.g. a "One Two" representation will return false when compared to a "Two One" representation)

Inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

Entity

Implementation of XML Schema type entity

extends lotus.domino.type.NCName

constructors:

public Entity()

No-argument (default) constructor

public Entity (String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:NCName, and if such, stores it as the object value

Inherited methods:

from lotus.domino.types.NCName:

public boolean isValid(String stValue)

Parses the String argument for a valid xsd:NCName, and if such, returns true, else false

public void setValue(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:NCName, and if such, stores it as the object value

public String toString()

Returns the XML representation of the xsd:entity object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

Fault

Implementation of SOAP 1.1 fault

extends lotus.domino.axis.AxisFault (abstract class as of Domino Designer 8.0)

constructors:

public Fault()

No-argument constructor -- see "set" methods

public Fault(String message)

One-argument constructor that sets the value for the returned SOAP 1.1 <faultstring> subelement from the message argument. The returned <faultcode> subelement defaults to "soapenv:Server.generalException".

makFault:

public static Fault makFault( java.lang.Exception e )

Make a lotus.domino.types.Fault based on a java.lang.Exception. If the Exception is already a Fault, use that. If the Exception wraps another Exception (.e.g an InvocationTargetException), base the returned Fault on the wrapped Exception.

methods:

serialize:

   public void serialize(javax.xml.rpc.encoding.SerializationContext Icontext,
       QName elemQName,
       Object value) throws java.io.IOException

A public method reserved for implementing writeDetails (see method writeDetails).

setFaultActor:

public void setFaultActor( String actor )

Sets the value for the SOAP 1.1 <faultactor> subelement on the returned SOAP fault.

Associated getter:

public String getFaultActor()

setFaultCode:

setFaultCodeAsString:

public void setFaultCode( String code )
public void setFaultAsString( String code )

Either setFaultCode or setFaultCodeAsString sets the code value for the SOAP 1.1 <faultcode> subelement on the returned SOAP fault (the full SOAP 1.1 faultcode is always a qualified name, namespace "http://schemas.xmlsosap.org/soap/envelope"). The default faultcode value is "Server".

Associated getter:

public javax.xml.namespace.QName getFaultCode()

setFaultCode:

public void setFaultCode( javax.xml.namespace.QName code )

Sets the fully-qualified value (namespace and code value) for the SOAP 1.1 <faultcode> subelement on the returned SOAP fault. The default faultcode value is "http://schemas.xmlsoap.org/soap/envelope" "Server".

Associated getter:

public javax.xml.namespace.QName getFaultCode()

setFaultDetail( org.w3c.dom.Element[ ] )

public void setFaultDetail( org.w3c.dom.Element[ ] details )

Adds the content of the Element array argument to become the subelement(s) and value(s) for the SOAP 1.1 <detail> subelement on the returned SOAP fault.

Clears any current details content for the Fault.

setFaultDetailString:

public void setFaultDetailString( String details )

Sets a <string> subelement and value for the SOAP 1.1 <detail> subelement on the returned SOAP fault. Clears any current details content for the Fault.

setFaultString:

public void setFaultString( String str )

Sets the value for the SOAP 1.1 <faultstring> subelement on the returned SOAP fault.

Associated getter (may return an empty String, but never null):

public String getFaultString()

toString

public String toString()

Same behavior as getFaultString( ). Also may return an empty String, but never null.

writeDetails

   public void writeDetails(QName qname, javax.xml.rpc.encoding.SerializationContext context) 
                                           throws java.io.IOException

A public callback typically used by internal handlers to serialize a lotus.domino.types.Fault. Fault subclasses may use an overridden version of this method; WSDL import may generate such overrides.

Inherited methods:

from java.lang.Object:

equals

getClass

hashCode

notify

notifyAll

wait (3)

from java.lang.Throwable:

fillInStackTrace

getLocalizedMessage

getStackTrace

initCause

printStackTrace (3)

setStackTrace

from java.rmi.RemoteException

getMessage

from lotus.domino.axis.AxisFault: (Domino Designer 7.x only)

*makeFault (2) -- public methods inherited from the superclass of lotus.domino.types.Fault. Do not use. Use "makFault" instead.

GDay

Implementation of XML Schema gregorian day type gDay

constructors:

public GDay(int day) throws NumberFormatException

Checks the int argument for a valid day of the month (greater than 0 and less than 32), and if such, stores it as the day component.

public GDay(int day, String timezone)

Checks the int argument for a valid day of the month (greater than 0 and less than 32), and if such, stores it as the day component.

Parses the String argument for a time zone expression in valid XML Schema time zone offset form, that is, either Z for Coordinated Universal Time (UCT), or + or - (plus or minus) followed by hh:mm as the +/- hours:minutes offset from UCT. If the expression is in valid time zone form, stores it as the time zone component.

public GDay(String source) throws NumberFormatException

Parses the String argument for an XML gDay expression, including valid day of the month in XML Schema left-truncated date form, i.e. "- - - D D" (three dashes followed by two digits), followed by an optional time zone expression. If such, stores it as the day (and optional time zone) component(s).

methods:

public int getDay()

Returns the day component of the current gDay value.

public void setDay(int day)
public void setValue(int day) throws NumberFormatException

Both methods check the int argument for a valid day of the month (greater than 0 and less than 32), and if such, store it as the day component.

public String getTimezone()

Returns the time zone component of the current gDay value.

public void setTimezone(String timezone)

Parses the String argument for a time zone expression in valid XML Schema time zone offset form, i.e. either "Z" for Coordinated Universal Time (UCT), or "+" or "-" (plus or minus) followed by hh:mm as the +/- hours:minutes offset from UCT. If the expression is in valid time zone form, stores it as the time zone component..

public void setValue(int day, String timezone)

Checks the int argument for a valid day of the month (greater than 0 and less than 32), and if such, stores it as the day component.

public String toString()

Returns the XML representation of the xsd:gDay object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object obj)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

Inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

GMonth

Implementation of XML Schema gregorian month type gMonth

constructors:

public GMonth(int month) throws NumberFormatException

Checks the int argument for a valid month (1 through 12), and if such, stores it as the month component.

public GMonth(int month, String timezone)

Checks the int argument for a valid month (1 through 12), and if such, stores it as the month component.

public GMonth(String source) throws NumberFormatException

Parses the String argument for an XML gMonth expression, including valid month in XML Schema left- and right-truncated date form, that is, - - M M - - (two dashes followed by two digits followed by two dashes), followed by an optional time zone expression. If such, stores it as the month (and optional time zone) component(s).

methods:

public int getMonth()

Returns the month component of the current gMonth value.

public void setMonth(int month)
public void setValue(int month) throws NumberFormatException

Both methods check the int argument for a valid month (1 through 12), and if such, store it as the month component.

public String getTimezone()

Returns the time zone component of the current gMonth value.

public void setTimezone(String timezone)

public void setValue(int month, String timezone)

Checks the int argument for a valid month (1 through 12), and if such, stores it as the month component.

public String toString()

Returns the XML representation of the xsd:gMonth object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object obj)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

Inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

GMonthDay

Implementation of XML Schema gregorian day of a month type gMonthDay

constructors:

public GMonthDay(int month, int day) throws NumberFormatException

Checks the int arguments for a valid day of a valid month (1 through 12), and if such, stores them as the month and day components.

public GMonthDay(int month, int day, String timezone)

Checks the int arguments for a valid day of a valid month (1 through 12), and if such, stores them as the month and day components.

public GMonthDay(String source) throws NumberFormatException

Parses the String argument for an XML GMonthDay expression, including valid month and day in XML Schema left-truncated date form "-- MM-DD" (two dashes, followed by two digits, followed by a dash, followed by two digits ), followed by an optional time zone expression. If such, stores it as the month and day (and optional time zone) components.

methods:

public int getMonth()

Returns the month component of the current GMonthDay value.

public int getDay()

Returns the day component of the current GMonthDay value.

   public void setMonth(int month)
   public void setDay(int day)
   public void setValue(int month, int day) throws NumberFormatException

All methods check the int arguments for a valid month (1 through 12) or valid day of the current month, and if such, store them as the month or day components.

public String getTimezone()

Returns the time zone component of the current GMonthDay value.

public void setTimezone(String timezone)

public void setValue(int month, int day, String timezone)

Checks the int arguments for a valid month (1 through 12) and day, and if such, stores them as the month and day components.

public String toString()

Returns the XML representation of the xsd:GMonthDay object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object obj)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

Inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

GYear

Implementation of XML Schema gregorian year type gYear

constructors:

public GYear(int year) throws NumberFormatException

Checks the int argument for a valid year (not 0), and if such, stores it as the year component.

public GYear(int year, String timezone)

Checks the int argument for a valid year (not 0), and if such, stores it as the year component.

public GYear(String source) throws NumberFormatException

Parses the String argument for an XML gYear expression, including valid year in XML Schema right-truncated dateTime form "[-]CCYY" (at least four digits with an optional leading "-" minus sign), followed by an optional time zone expression. If such, stores it as the year (and optional time zone) component(s).

methods:

public int getYear()

Returns the year component of the current gYear value.

   public void setYear(int year)
   public void setValue(int year) throws NumberFormatException

Both methods check the int argument for a valid year (not 0), and if such, store it as the year component.

public String getTimezone()

Returns the time zone component of the current gYear value.

public void setTimezone(String timezone)

public void setValue(int year, String timezone)

Checks the int argument for a valid year (not 0), and if such, stores it as the year component.

public String toString()

Returns the XML representation of the xsd:gYear object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object obj)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

Inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

GYearMonth

Implementation of XML Schema gregorian month of a year type gYearMonth

constructors:

public GYearMonth(int year, int month) throws NumberFormatException

Checks the int arguments for a valid year (not 0) and month (1 through 12), and if such, stores them as the year and month components.

public GYearMonth(int year, int month, String timezone)

Checks the int arguments for a valid year (not 0) and month (1 through 12), and if such, stores them as the year and month components.

public GYearMonth(String source) throws NumberFormatException

Parses the String argument for an XML GYearMonth expression, including valid year and month in XML Schema right-truncated dateTime form "[-]CCYY - MM" (at least four digits with an optional leading "-" minus sign, followed by a dash, followed by two digits ), followed by an optional time zone expression. If such, stores it as the year and month (and optional time zone) components.

methods:

public int getYear()

Returns the year component of the current GYearMonth value.

public int getMonth()

Returns the month component of the current GYearMonth value.

   public void setYear(int year)
   public void setMonth(int month)
   public void setValue(int year, int month) throws NumberFormatException

All methods check the int arguments for a valid year (not 0) and/or month (1 through 12), and if such, store them as the year or month components.

public String getTimezone()

Returns the time zone component of the current GYearMonth value.

public void setTimezone(String timezone)

public void setValue(int year, int month, String timezone)

Checks the int arguments for a valid year (not 0) and month (1 through 12), and if such, stores them as the year and month components.

public String toString()

Returns the XML representation of the xsd:GYearMonth object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object obj)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

Inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

HexBinary

Implementation of XML Schema numeric type hexBinary

constructors:

public HexBinary()

No-argument (default) constructor

public HexBinary(String string){

Parses the String argument for an even number of valid hexadecimal digit characters, and if found, decodes them as the object's raw value.

public HexBinary(byte[] bytes){

Sets the object's raw value directly from the byte[ ] argument.

methods:

public byte[] getBytes()

Returns the object's raw value.

public String toString()

Returns the object's value, encoded as a String of hexadecimal digits.

public int hashCode()

Overridden java.lang.Object method

public static byte[] decode(String digits)

Parses the String argument for an even number of valid hexadecimal digit characters, and if found, returns them as a decoded raw byte[ ]

public static String encode(byte bytes[])

Returns the byte[ ] argument encoded as a String of hexadecimal digits.

public static int convert2Int( byte[] hex )

Returns a decimal integer representation of the byte[ ] argument's first four hexadecimal digits

inherited methods:

from java.lang.Object:

equals

getClass

notify

notifyAll

wait (3)

Implementation of XML Schema type ID

extends lotus.domino.types.NCName

constructors:

public Id()

No-argument (default) constructor

public Id(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:NCName, and if such, stores it as the object value

Inherited methods:

from lotus.domino.types.NCName:

public boolean isValid(String stValue)

Parses the String argument for a valid xsd:NCName, and if such, returns true, else false

public void setValue(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:NCName, and if such, stores it as the object value

public String toString()

Returns the XML representation of the xsd:NCName object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

IDRef

Implementation of XML Schema type IDREF

extends lotus.domino.types.NCName

constructors:

public IDRef()

No-argument (default) constructor

public IDRef(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:NCName, and if such, stores it as the object value

Inherited methods:

from lotus.domino.types.NCName:

public boolean isValid(String stValue)

Parses the String argument for a valid xsd:NCName, and if such, returns true, else false

public void setValue(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:NCName, and if such, stores it as the object value

public String toString()

Returns the XML representation of the xsd:NCName object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

IDRefs

Implementation of XML Schema type IDRefs

constructors:

public IDRefs()

No-argument (default) constructor

public IDRefs(String stValue) throws IllegalArgumentException

Parses the String argument for one or more string tokens, stored as the object's list of lotus.domino.types.IDRef value(s)

public IDRefs(IDRef[] entValues)

Stores the lotus.domino.types.IDRef[ ] argument as the object's list of IDRef value(s)

property getters/setters:

   public IDRef[] getValue()
   public void setValue(IDRef[] entValues)
   public void setValue(String stValue)

Parses the String argument for one or more string tokens, stored as the object's list of lotus.domino.types.IDRef value(s)

methods:

public String toString()

Returns the XML representation of the xsd:IDRefs object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations (e.g. a "One Two" representation will return false when compared to a "Two One" representation)

Inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

Language

Implementation of XML Schema type Language

extends lotus.domino.types.Token

constructors:

public Language()

No-argument (default) constructor

public Language(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:token, and if such, stores it as the object value

Inherited methods:

from lotus.domino.types.Token:

public boolean isValid(String stValue)

Parses the String argument for a valid xsd:token, and if such, returns true, else false

public void setValue(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:token, and if such, stores it as the object value

public String toString()

Returns the XML representation of the xsd:token object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

Name

Implementation of XML Schema type Name

extends lotus.domino.types.Token

constructors:

public Name()

No-argument (default) constructor

public Name(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:Name, and if such, stores it as the object value

methods:

public boolean isValid(String stValue)

Parses the String argument for a valid xsd:Name, and if such, returns true, else false

Inherited methods:

from lotus.domino.types.Token:

public void setValue(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:Name, and if such, stores it as the object value

public String toString()

Returns the XML representation of the xsd:Name object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

NCName

Implementation of XML Schema type NCName

extends lotus.domino.types.Name

constructors:

public NCName()

No-argument (default) constructor

public NCName(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:NCName, and if such, stores it as the object value

methods:

public boolean isValid(String stValue)

Parses the String argument for a valid xsd:NCName, and if such, returns true, else false

Inherited methods:

from lotus.domino.types.Name:

public void setValue(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:NCName, and if such, stores it as the object value

public String toString()

Returns the XML representation of the xsd:NCName object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

NegativeInteger

Implementation of XML Schema type negativeInteger

extends lotus.domino.types.NonPositiveInteger

constructors:

public NegativeInteger(byte[] val)

Invokes NonPositiveInteger constructor of the same signature; throws NumberFormatException if input value > 0

public NegativeInteger(int signum, byte[] magnitude)

Invokes NonPositiveInteger constructor of the same signature; throws NumberFormatException if input value > 0

public NegativeInteger(int bitLength, int certainty, Random rnd)

Invokes NonPositiveInteger constructor of the same signature; throws NumberFormatException if input value > 0

public NegativeInteger(int numBits, Random rnd)

Invokes NonPositiveInteger constructor of the same signature; throws NumberFormatException if input value > 0

public NegativeInteger(String val)

Invokes NonPositiveInteger constructor of the same signature; throws NumberFormatException if input value > 0

public NegativeInteger(String val, int radix)

Invokes NonPositiveInteger constructor of the same signature; throws NumberFormatException if input value > 0

Inherited methods:

See java.math.BigInteger documentation.

NMToken

Implementation of XML Schema type NMTOKEN

extends lotus.domino.types.Token

constructors:

public NMToken()

No-argument (default) constructor

public NMToken(String stValue) throws IllegalArgumentException

Parses the String argument for valid XML name characters, and if such, stores it as the object value

methods:

public boolean isValid(String stValue)

Parses the String argument for valid XML name characters, and if such, returns true, else false

Inherited methods:

from lotus.domino.types.Token:

public void setValue(String stValue) throws IllegalArgumentException

Parses the String argument for valid XML name characters, and if such, stores it as the object value

public String toString()

Returns the XML representation of the xsd:NMTOKEN object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

NMTokens

Implementation of XML Schema type NMTOKENS

constructors:

public NMTokens()

No-argument (default) constructor

public NMTokens(String stValue) throws IllegalArgumentException

Parses the String argument for one or more string tokens, stored as the object's list of lotus.domino.types.NMToken value(s)

public NMTokens(NMToken[] entValues)

Stores the lotus.domino.types.NMToken[ ] argument as the object's list of NMToken value(s)

property getters/setters:

   public NMToken[] getValue()
   public void setValue(NMToken[] entValues)
   public void setValue(String stValue)

Parses the String argument for one or more string tokens, stored as the object's list of lotus.domino.types.NMToken value(s)

methods:

public String toString()

Returns the XML representation of the xsd:NMTOKENS object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations (e.g. a "One Two" representation will return false when compared to a "Two One" representation)

Inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

NonNegativeInteger

Implementation of XML Schema type nonNegativeInteger

extends java.math.BigInteger

constructors:

public NonNegativeInteger(byte[] val)

Invokes BigInteger constructor of the same signature; throws NumberFormatException if input value < 0

public NonNegativeInteger(int signum, byte[] magnitude)

Invokes BigInteger constructor of the same signature; throws NumberFormatException if input value < 0

public NonNegativeInteger(int bitLength, int certainty, Random rnd)

Invokes BigInteger constructor of the same signature; throws NumberFormatException if input value < 0

public NonNegativeInteger(int numBits, Random rnd)

Invokes BigInteger constructor of the same signature; throws NumberFormatException if input value < 0

public NonNegativeInteger(String val)

Invokes BigInteger constructor of the same signature; throws NumberFormatException if input value < 0

public NonNegativeInteger(String val, int radix)

Invokes BigInteger constructor of the same signature; throws NumberFormatException if input value < 0

Inherited methods:

See java.math.BigInteger documentation.

NonPositiveInteger

Implementation of XML Schema type nonPositiveInteger

extends java.math.BigInteger

constructors:

public NonPositiveInteger(byte[] val)

Invokes BigInteger constructor of the same signature; throws NumberFormatException if input value > 0

public NonPositiveInteger(int signum, byte[] magnitude)

Invokes BigInteger constructor of the same signature; throws NumberFormatException if input value > 0

public NonPositiveInteger(int bitLength, int certainty, Random rnd)

Invokes BigInteger constructor of the same signature; throws NumberFormatException if input value > 0

public NonPositiveInteger(int numBits, Random rnd)

Invokes BigInteger constructor of the same signature; throws NumberFormatException if input value > 0

public NonPositiveInteger(String val)

Invokes BigInteger constructor of the same signature; throws NumberFormatException if input value > 0

public NonPositiveInteger(String val, int radix)

Invokes BigInteger constructor of the same signature; throws NumberFormatException if input value > 0

Inherited methods:

See java.math.BigInteger documentation.

NormalizedString

Implementation of XML Schema type normalizedString

extends java.lang.Object

constructors:

public NormalizedString()

No-argument (default) constructor

public NormalizedString(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:normalizedString, and if such, stores it as the object value

methods:

public boolean isValid(String stValue)

Parses the String argument for a valid xsd:normalizedString, and if such, returns true, else false

public void setValue(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:normalizedString, and if such, stores it as the object value

public String toString()

Returns the XML representation of the xsd:normalizedString object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

Notation

Implementation of XML Schema notation element type

constructors:

public Notation()

No-argument (default) constructor

public Notation(NCName name, URI publicURI, URI systemURI)

Sets the notation elemen's current attribute values from the specified arguments.

methods:

   public NCName getName()
   public void setName(NCName name)

Gets/sets the element's current name attribute value;

   public URI getPublic()
   public void setPublic(URI publicURI)

Gets/sets the element's current public attribute value;

   public URI getSystem()
   public void setSystem(URI systemURI)

Gets/sets the element's current system attribute value;

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object obj)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

public static TypeDesc getTypeDesc()

For internal use. Do not use.

inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

toString

wait (3)

PositiveInteger

Implementation of XML Schema type positiveInteger

extends lotus.domino.types.NonNegativeInteger

constructors:

public PositiveInteger(byte[] val)

Invokes NonNegativeInteger constructor of the same signature; throws NumberFormatException if input value < 0

public PositiveInteger(int signum, byte[] magnitude)

Invokes NonNegativeInteger constructor of the same signature; throws NumberFormatException if input value < 0

public PositiveInteger(int bitLength, int certainty, Random rnd)

Invokes NonNegativeInteger constructor of the same signature; throws NumberFormatException if input value < 0

public PositiveInteger(int numBits, Random rnd)

Invokes NonNegativeInteger constructor of the same signature; throws NumberFormatException if input value < 0

public PositiveInteger(String val)

Invokes NonNegativeInteger constructor of the same signature; throws NumberFormatException if input value < 0

public PositiveInteger(String val, int radix)

Invokes NonNegativeInteger constructor of the same signature; throws NumberFormatException if input value < 0

Inherited methods:

See java.math.BigInteger documentation.

Time

Implementation of XML Schema type time

constructors:

public Time(Calendar value)

Sets the time and time zone components of the Calendar argument as the current value. Year, month, and day are ignored.

public Time(String value) throws NumberFormatException {

Parses the String argument for an XML time expression, in XML Schema left-truncated dateTime form "hh:mm:ss[:sss]" (two digits, colon, two digits, colon, two digits, and optional colon, three digits), followed by an optional time zone expression, i.e. either "Z" for Coordinated Universal Time (UCT), or "+" or "-" (plus or minus) followed by hh:mm as the +/- hours:minutes offset from UCT.

If such, stores it as the time (and optional time zone) component(s).

public Calendar getAsCalendar()

Returns the current value as a Calendar object.

public void setTime(Calendar date)

Sets the time and time zone components of the Calendar argument as the current value. Year, month, and day are ignored.

public void setTime(Date date)

Sets the time component of the Date argument as the current value. Year, month, and day are ignored.

methods:

public String toString()

Returns the XML representation of the xsd:time object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object obj)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

Token

Implementation of XML Schema type token

extends lotus.domino.types.NormalizedString

constructors:

public Token()

No-argument (default) constructor

public Token(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:token, and if such, stores it as the object value

methods:

public boolean isValid(String stValue)

Parses the String argument for a valid xsd:token, and if such, returns true, else false

Inherited methods:

from lotus.domino.types.NormalizedString:

public void setValue(String stValue) throws IllegalArgumentException

Parses the String argument for a valid xsd:token, and if such, stores it as the object value

public String toString()

Returns the XML representation of the xsd:token object

public int hashCode()

Overridden java.lang.Object method

public boolean equals(Object object)

Overridden java.lang.Object method, performs a comparison on the objects' XML representations

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

UnsignedByte

Implementation of XML Schema type unsignedByte

extends lotus.domino.types.UnsignedShort

constructors:

public UnsignedByte()

No-argument (default) constructor

public UnsignedByte(long value) throws NumberFormatException

Validates the long argument as within the acceptable range defined by XML Schema, and if such, stores it as the object value

public UnsignedByte(String value) throws NumberFormatException

Parses the String argument for a value within the acceptable range defined by XML Schema, and if such, stores it as the object value

methods:

public void setValue(long value) throws NumberFormatException

Validates the long argument as within the acceptable range defined by XML Schema, and if such, stores it as the object value

public boolean isValid(long value)

Validates the long argument as within the acceptable range defined by XML Schema, and if such, returns true, else false.

Range: 0 to 255, inclusive

Inherited methods:

See lotus.domino.types.UnsignedInt documentation.

UnsignedInt

Implementation of XML Schema type unsignedInt

extends java.lang.Number

implements java.lang.Comparable

constructors:

public UnsignedInt()

No-argument (default) constructor

public UnsignedInt(long lValue) throws NumberFormatException

Validates the long argument as within the acceptable range defined by XML Schema, and if such, stores it as the object value

public UnsignedInt(String stValue) throws NumberFormatException

Parses the String argument for a value within the acceptable range defined by XML Schema, and if such, stores it as the object value

methods:

public void setValue(long lValue) throws NumberFormatException

Validates the long argument as within the acceptable range defined by XML Schema, and if such, stores it as the object value

public String toString()

Returns the object value in String representation, or null if not set.

public int hashCode()

Overridden java.lang.Object method

public boolean isValid(long lValue)

Validates the long argument as within the acceptable range defined by XML Schema, and if such, returns true, else false.

Range: 0 to 4294967295, inclusive

public synchronized boolean equals(Object obj)

Overridden java.lang.Object method, performs a comparison of the objects' states and values.

implemented methods:

from java.lang.comparable:

public int compareTo(Object obj)

Performs a comparison of the objects' states and values.

from java.lang.Number:

public byte byteValue()

Returns the object value as a byte

public short shortValue()

Returns the object value as a short

public int intValue()

Returns the object value as an int

public long longValue()

Returns the object value as a long

public double doubleValue()

Returns the object value as a double

public float floatValue()

Returns the object value as a float

inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

UnsignedLong

Implementation of XML Schema type unsignedLong

extends java.lang.Number

implements java.lang.Comparable

constructors:

public UnsignedLong()

No-argument (default) constructor.

public UnsignedLong(double lValue) throws NumberFormatException

Validates the double argument as within the acceptable range defined by XML Schema, and if such, stores it as the object value.

public UnsignedLong(String stValue) throws NumberFormatException

Parses the String argument for a double value within the acceptable range defined by XML Schema, and if such, stores it as the object value.

public UnsignedLong(BigInteger llValue) throws NumberFormatException

New with release 8.0. Validates the BigInteger argument as within the acceptable range defined by XML Schema, and if such, stores it as the object value.

methods:

public void setValue(double lValue) throws NumberFormatException

Validates the double argument as within the acceptable range defined by XML Schema, and if such, stores it as the object value.

public String toString()

Returns the object value in String representation, or null if not set.

public int hashCode()

Overridden java.lang.Object method.

public boolean isValid(double lValue)

Validates the double argument as within the acceptable range defined by XML Schema, and if such, returns true, else false.

Range: 0 to 18446744073709551615, inclusive

public synchronized boolean equals(Object obj)

Overridden java.lang.Object method, performs a comparison of the objects' states and values.

implemented methods:

from java.lang.comparable:

public int compareTo(Object obj)

Performs a comparison of the objects' states and values.

from java.lang.Number:

public byte byteValue()

Returns the object value as a byte.

public short shortValue()

Returns the object value as a short.

public int intValue()

Returns the object value as an int.

public long longValue()

Returns the object value as a long.

public double doubleValue()

Returns the object value as a double.

public float floatValue()

Returns the object value as a float.

public byte byteValue()

New with release 8.0. Returns the object value as a byte (returns 0, if object value is a BigInteger).

public short shortValue()

New with release 8.0. Returns the object value as a short (returns 0, if object value is a BigInteger).

inherited methods:

from java.lang.Object:

getClass

notify

notifyAll

wait (3)

UnsignedShort

Implementation of XML Schema type unsignedShort

extends lotus.domino.types.UnsignedInt

constructors:

public UnsignedShort()

No-argument (default) constructor

public UnsignedShort(long sValue) throws NumberFormatException

Validates the long argument as within the acceptable range defined by XML Schema, and if such, stores it as the object value

public UnsignedShort(String sValue) throws NumberFormatException

Parses the String argument for a value within the acceptable range defined by XML Schema, and if such, stores it as the object value

methods:

public void setValue(long sValue) throws NumberFormatException

Validates the long argument as within the acceptable range defined by XML Schema, and if such, stores it as the object value

public boolean isValid(long sValue)

Validates the long argument as within the acceptable range defined by XML Schema, and if such, returns true, else false.

Range: 0 to 65535, inclusive

Inherited methods:

See lotus.domino.types.UnsignedInt documentation.

Helper classes

The following holder classes implement interface javax.xml.rpc.holders.Holder, and are supplied for passing values of the indicated type:


Holder class	Holds a public value...
Base64BinaryHolder	member of type lotus.domino.types.Base64Binary
DateHolder	member of type java.util.Date
DurationHolder	member of type lotus.domino.types.Duration
EntitiesHolder	member of type lotus.domino.types.Entities
EntityHolder	member of type lotus.domino.types.Entity
GDayHolder	member of type lotus.domino.types.GDay
GMonthDayHolder	member of type lotus.domino.types.GMonthDay
GMonthHolder	member of type lotus.domino.types.GMonth
GYearHolder	member of type lotus.domino.types.GYear
GYearMonthHolder	member of type lotus.domino.types.GYearMonth
HexBinaryHolder	member of type lotus.domino.types.HexBinary
IdHolder	member of type lotus.domino.types.Id
IDRefHolder	member of type lotus.domino.types.IDRef
IDRefsHolder	member of type lotus.domino.types.IDRefs
LanguageHolder	member of type lotus.domino.types.Language
NameHolder	member of type lotus.domino.types.Name
NCNameHolder	member of type lotus.domino.types.NCName
NegativeIntegerHolder	member of type lotus.domino.types.NegativeInteger
NMTokenHolder	member of type lotus.domino.types.NMToken
NMTokensHolder	member of type lotus.domino.types.NMTokens
NonNegativeIntegerHolder	member of type lotus.domino.types.NonNegativeInteger
NonPositiveIntegerHolder	member of type lotus.domino.types.NonPositiveInteger
NormalizedStringHolder	member of type lotus.domino.types.NormalizedString
NotationHolder	member of type lotus.domino.types.Notation
PositiveIntegerHolder	member of type lotus.domino.types
SOAPElementHolder	member of type javax.xml.soap.SOAPElement
SOAPElementArrayHolder	array member of type javax.xml.soap.SOAPElement
TimeHolder	member of type lotus.domino.types.Time
TokenHolder	member of type lotus.domino.types.Token
UnsignedByteHolder	member of type lotus.domino.types.UnsignedByte
UnsignedIntHolder	member of type lotus.domino.types.UnsignedInt
UnsignedLongHolder	member of type lotus.domino.types.UnsignedLong
UnsignedShortHolder	member of type lotus.domino.types.UnsignedShort