All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.MessageFile

java.lang.Object
   |
   +----com.ibm.as400.access.MessageFile

public class MessageFile
extends Object
implements Serializable
The MessageFile class allows a user to get a message from an AS/400 message file. It returns an AS400Message object which contains the message. The calling program can optionally supply substitution text for the message.

For example, to retrieve and print a message:

AS400 system = new AS400("mysystem.mycompany.com");
MessageFile messageFile = new MessageFile(system);
messageFile.setPath("/QSYS.LIB/QCPFMSG.MSGF");
AS400Message message = messageFile.getMessage("CPD0170");
System.out.println(message.getText());

See Also:
AS400Message, QSYSObjectPathName

Constructor Index

 o MessageFile()
Constructs a MessageFile object.
 o MessageFile(AS400)
Constructs a MessageFile object.
 o MessageFile(AS400, String)
Constructs a message file object.

Method Index

 o addPropertyChangeListener(PropertyChangeListener)
Adds a PropertyChangeListener.
 o addVetoableChangeListener(VetoableChangeListener)
Adds a VetoableChangeListener.
 o getMessage(String)
Returns a message object containing the message.
 o getMessage(String, String)
Returns a message object containing the message.
 o getPath()
Returns the integrated file system pathname for the message file.
 o getSystem()
Returns the AS/400 which contains the message file.
 o removePropertyChangeListener(PropertyChangeListener)
Removes this PropertyChangeListener from the internal list.
 o removeVetoableChangeListener(VetoableChangeListener)
Removes this VetoableChangeListener from the internal list.
 o setPath(String)
Sets the message file name.
 o setSystem(AS400)
Sets the AS/400 which contains the message file.

Constructors

 o MessageFile
 public MessageFile()
Constructs a MessageFile object. The system and message file name must be provided later.

 o MessageFile
 public MessageFile(AS400 system)
Constructs a MessageFile object. It uses the specified AS/400. The message file name must be provided later.

Parameters:
system - The AS/400 which contains the message file.
 o MessageFile
 public MessageFile(AS400 system,
                    String path)
Constructs a message file object. It uses the specified AS/400 and message file name.

Parameters:
system - The AS/400 which contains the message file
path - The integrated file system pathname for the message file. That is, the message file name as a fully qualified path name in the library file system. The library and message file name must each be 10 characters or less. The extension for message files is .msgf. For example, /QSYS.LIB/MYLIB.LIB/MSGFILE.MSGF.

Methods

 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener. The specified PropertyChangeListeners propertyChange method will be called each time the value of any bound property is changed. The PropertyListener object is added to a list of PropertyChangeListeners managed by this MessageFile. It can be removed with removePropertyChangeListener.

Parameters:
listener - The PropertyChangeListener.
See Also:
removePropertyChangeListener
 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener listener)
Adds a VetoableChangeListener. The specified VetoableChangeListeners vetoableChange method will be called each time the value of any constrained property is changed. The VetoableChangeListener object is added to a list of listeners managed by this MessageFile, it can be removed with removeVetoableChangeListener.

Parameters:
listener - The VetoableChangeListener.
See Also:
removeVetoableChangeListener
 o getPath
 public String getPath()
Returns the integrated file system pathname for the message file. It will return null if not previously set.

Returns:
The integrated file system pathname for the program.
 o getMessage
 public AS400Message getMessage(String ID) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, PropertyVetoException
Returns a message object containing the message. The system and message file name must be set before calling this method.

Parameters:
ID - The message identifier.
Returns:
An AS400Message object containing the message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: PropertyVetoException
If a change is vetoed.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
 o getMessage
 public AS400Message getMessage(String ID,
                                String substitutionText) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, PropertyVetoException
Returns a message object containing the message. The system and message file name must be set before calling this method. Up to 1024 bytes of substitution text can be supplied to this method. The calling program is responsible for correctly formatting the string containing the substitution text for the specified message.

For example, using AS/400 command DSPMSGD, we see the format of the substitution text for message CPD0170 is char 4, char 10, char 10. Passing string

"12  abcd      xyz"
as the substitution text on this call means "12" will be substituted for &1, "abcd" will be substituted for &2, and "xyz" will be substituted for &3.

Parameters:
ID - The message identifier.
substitutionText - The substitution text.
Returns:
An AS400Message object containing the message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: PropertyVetoException
If a change is vetoed.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
 o getSystem
 public AS400 getSystem()
Returns the AS/400 which contains the message file.

Returns:
The AS/400 which contains the message file.
 o removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener listener)
Removes this PropertyChangeListener from the internal list. If the PropertyChangeListener is not on the list, nothing is done.

Parameters:
listener - The PropertyChangeListener.
See Also:
addPropertyChangeListener
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener listener)
Removes this VetoableChangeListener from the internal list. If the VetoableChangeListener is not on the list, nothing is done.

Parameters:
listener - The VetoableChangeListener.
See Also:
addVetoableChangeListener
 o setPath
 public void setPath(String path) throws PropertyVetoException
Sets the message file name. The name cannot be changed after retrieving a message from the AS/400.

Parameters:
path - The integrated file system pathname for the message file. That is, the message file name as a fully qualified path name in the library file system. The library and file name must each be 10 characters or less. The extension for message files is .msgf. For example, /QSYS.LIB/MyLib.LIB/MyFile.MSGF.
Throws: PropertyVetoException
If a change is vetoed.
 o setSystem
 public void setSystem(AS400 system) throws ExtendedIllegalStateException, PropertyVetoException
Sets the AS/400 which contains the message file. The system cannot be changed after retrieving a message from the AS/400.

Parameters:
system - The AS/400 which contains the message file.
Throws: PropertyVetoException
If a change is vetoed.

All Packages  Class Hierarchy  This Package  Previous  Next  Index