|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface SFMessageFile
The SFMessageFile interface provides methods to allow easy construction of message files. Message files contain messages which can be used as inputs and outputs to operations.
| Method Summary | |
|---|---|
void |
addMessage(SFMessage message)
Adds a message to the message file. |
java.util.List<SFMessage> |
getMessages()
|
java.lang.String |
getName()
|
org.eclipse.xsd.XSDSchema |
getSchema()
|
void |
save()
Saves the message file. |
void |
setName(java.lang.String name)
Sets the name of the message file. |
void |
setSchema(org.eclipse.xsd.XSDSchema schema)
Sets the XML schema model for this message file. |
| Method Detail |
|---|
java.lang.String getName()
void setName(java.lang.String name)
throws SFException
name - The name of the file. The name must not include the
path. If the name does not include the ".mxsd"
extension, the ".mxsd" extension will be added.
SFException - In case the supplied name is not valid, one of the
following exceptions may result:
| Error | Description | Severity |
| WZEF1001E_ARGSERROR | Illegal arguments. The name is null. | ERROR: The name was not set successfully. |
| WZEF1300E_FILENAMENOTVALID | The file name is not a valid file name or the file name contains illegal message file characters such as a space or '#' character. | ERROR: The name was not set successfully. |
java.util.List<SFMessage> getMessages()
throws SFException
SFException
void addMessage(SFMessage message)
throws SFException
message - A message.
SFException - In case the supplied message is not valid, one of the
following exceptions may result:
| Error | Description | Severity |
| WZEF1001E_ARGSERROR | Illegal arguments. The message is null. | ERROR: The message was not set added successfully. |
| WZEF1103E_MESSAGENOTNAMED | The message is not named. | ERROR: The message was not set added successfully. |
| WZEF1104E_MESSAGENAMECONFLICT | The message file contains at least two messages with the same name. | ERROR: The message was not set added successfully. |
org.eclipse.xsd.XSDSchema getSchema()
void setSchema(org.eclipse.xsd.XSDSchema schema)
throws SFException
schema - An XML schema.
SFException - In case the supplied schema is not valid, one of the
following exceptions may result:
| Error | Description | Severity |
| WZEF1001E_ARGSERROR | Illegal arguments. The schema is null. | ERROR: The schema was not set successfully. |
void save()
throws SFException
SFException - In case the supplied schema is not valid, one of the
following exceptions may result:
| Error | Description | Severity |
| WZEF1301E_FILESAVEFAILED | The file save failed | ERROR: The file was not saved successfully. |
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||