28.2 Notification Web Service API

This section provides details about the methods available with the Notification Web service. This API presumes you’re using Java code generated by the WSSDK toolkit. The API will be different if you’re using another Web Service toolkit.

All of the methods throw RemoteException. To improve readability, the throws clause has been omitted from the method signatures.

28.2.1 iRemoteNotification

This section provides reference information for each method associated with the iRemoteNotification interface.

getVersion

Returns the version number of the notification facility you’re running.

Syntax: Here is the method signature:

VersionVO getVersion()

sendNotification

Sends an email notification.

Syntax: Here is the method signature:

void sendNotification(NotificationMap arg0)

28.2.2 BuiltInTokens

This section provides reference information for each method associated with the BuiltInTokens class.

BuiltInTokens constructor

The BuiltInTokens class has a single constructor.

Syntax: Here is the constructor for the BuiltInTokens class:

BuiltInTokens()

getTO

Returns the fixed string TO, which can be used as a key to identify the value for the TO system token.

Syntax: Here is the method signature:

public java.lang.String getTO()

getCC

Returns the fixed string CC, which can be used as a key to identify the value for the CC system token.

Syntax: Here is the method signature:

public java.lang.String getCC()

getBCC

Returns the fixed string BCC, which can be used as a key to identify the value for the BCC system token.

Syntax: Here is the method signature:

public java.lang.String getBCC()

getTO_DN

Returns the fixed string TO_DN, which can be used as a key to identify the value for the TO_DN system token.

Syntax Here is the method signature:

public java.lang.String getTO_DN()

getCC_DN

Returns the fixed string CC_DN, which can be used as a key to identify the value for the CC_DN system token.

Syntax: Here is the method signature:

public java.lang.String getCC_DN()

getBCC_DN

Returns the fixed string BCC_DN, which can be used as a key to identify the value for the BCC_DN system token.

Syntax: Here is the method signature:

public java.lang.String getBCC_DN()

getREPLYTO

Returns the fixed string REPLYTO, which can be used as a key to identify the value for the REPLYTO system token.

Syntax: Here is the method signature:

public java.lang.String getREPLYTO()

getREPLYTO_DN

Returns the fixed string REPLYTO_DN, which can be used as a key to identify the value for the REPLYTO_DN system token.

Syntax: Here is the method signature:

public java.lang.String getREPLYTO_DN()

getLOCALE

Returns the fixed string LOCALE, which can be used as a key to identify the value for the LOCALE system token.

Syntax: Here is the method signature:

public java.lang.String getLOCALE()

getNOTIFICATION_TEMPLATE_DN

Returns the fixed string NOTIFICATION_TEMPLATE, which can be used as a key to identify the value for the NOTIFICATION_TEMPLATE system token.

Syntax: Here is the method signature:

public java.lang.String getNOTIFICATION_TEMPLATE_DN()

28.2.3 Entry

The Entry class represents an entry in an EntryArray object. It is used to specify a token in an email template.

This section provides reference information for each method associated with the Entry class.

Entry constructors

The Entry class has two constructors.

Syntax 1: Here is the syntax for a constructor that takes no parameters:

Entry()

Syntax 2: Here is the syntax for a constructor that takes two parameters, the key value and an array of values:

Entry(java.lang.String KeyVal, StringArray ValuesVal)

getKey

Returns the key defined for the Entry object. The key identifies the token.

Syntax: Here is the method signature:

java.lang.String getKey()

setKey

Sets the key for the Entry object. The key identifies the token. If the object represents a built-in token, you can use the BuiltInTokens class to set the key. Otherwise, you can pass a string to the setKey method that specifies the key.

Syntax: Here is the method signature:

void setKey(java.lang.String KeyVal)

getValues

Returns a StringArray object representing the values for the Entry object.

Syntax: Here is the method signature:

StringArray getValues()

setValues

Sets the values for the Entry object.

Syntax: Here is the method signature:

void setValues(StringArray ValuesVal)

28.2.4 EntryArray

The EntryArray class is a container for an array of Entry objects. It is contained by the NotificationMap object.

This section provides reference information on the methods associated with the EntryArray class.

EntryArray constructors

The EntryArray class has two constructors.

Syntax 1: Here is the syntax for a constructor that takes no parameters:

EntryArray()

Syntax 2: Here is the syntax for a constructor that takes an array of Entry objects as a parameter:

EntryArray(Entry[] EntryVal)

getEntry

Returns the Entry object contained within this EntryArray object.

Syntax: Here is the method signature:

Entry[] getEntry()

setEntry

Sets the Entry object for this EntryArray object.

Syntax: Here is the method signature:

void setEntry(Entry[] EntryVal)

28.2.5 NotificationMap

The NotificationMap object is a map that contains an EntryArray object. It is passed to the sendNotification method on the stub.

This section provides reference information for the methods associated with the NotificationMap class.

NotificationMap constructors

The NotificationMap class has two constructors.

Syntax 1: Here is the syntax for a constructor that takes no parameters:

NotificationMap()

Syntax 2: Here is the syntax for a constructor that takes an EntryArray object as a parameter:

NotificationMap(EntryArray EntriesVal)

getEntries

Returns the EntryArray object contained by this NotificationMap object.

Syntax: Here is the method signature:

EntryArray getEntries()

setEntries

Sets the EntryArray object for this NotificationMap object.

Syntax: Here is the method signature:

void setEntries(EntryArray EntriesVal)

28.2.6 NotificationService

This section provides reference information for the NotificationService interface.

getIRemoteNotificationPort

Gets the stub for the remote service. The stub is a port of type IRemoteNotification.

Syntax: Here is the method signature:

IRemoteNotification getIRemoteNotificationPort() throws javax.xml.rpc.ServiceException

28.2.7 StringArray

This section provides reference information for the StringArray class.

StringArray constructors

The StringArray class has two constructors.

Syntax 1: Here is the syntax for a constructor that takes no parameters:

StringArray()

Syntax 2: Here is the syntax for a constructor that takes a String array as a parameter:

StringArray(java.lang.String[] StringVal)

getString

Returns the array of strings defined for this StringArray object.

Syntax: Here is the method signature:

java.lang.String[] getString()

setString

Sets the array of strings for this StringArray object. This method is called by the second constructor, which takes a String array as a parameter.

Syntax: Here is the method signature:

void setString(java.lang.String[] StringVal)

28.2.8 VersionVO

This section provides reference information on the VersionVO class.

getValue

Returns the version number of the service.

Syntax: Here is the method signature:

java.lang.String getValue()