Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.subsystems.qsys.api
Class ISeriesMessage

java.lang.Object
  extended by com.ibm.etools.iseries.subsystems.qsys.api.ISeriesMessage
All Implemented Interfaces:
IRemoteCommandContextProvider

public class ISeriesMessage
extends Object
implements IRemoteCommandContextProvider

This is a usable representation of a remote iSeries message. This is not a message description! It is a message returned as the result of executing a command.

This object is instantiated from the DataElement object that is normally returned from a remote command execution.


Field Summary
static String Copyright
           
 
Fields inherited from interface com.ibm.etools.iseries.subsystems.qsys.commands.IRemoteCommandContextProvider
copyright
 
Constructor Summary
ISeriesMessage(QSYSServiceSystemMessage qsysSystemMessage)
          Constructor for ISeriesMessage
 
Method Summary
 void displaySystemMessage(Shell shell)
          Display this host message as a locally displayable message in Eclipse
 String getAbsoluteName()
          From base class.
 Object getAdapter(Class adapterType)
           
 String getMessage()
           
 String getMessageHelp()
          Retrieve the message help
 String getMessageID()
          Retrieve the message id
 String getMessageSeverity()
          Retrieve the message severity
 int getMessageSeverityInt()
          Retrieve the message severity as an integer
 String getMessageText()
          Retrieve the message text
 String getMessageType()
          Retrieve the message type as a translated string
 Object getParent()
           
 IRemoteCommandContext getRemoteCommandContext()
          Get the remote context.
 ISeriesJobName getSubmittedJobInformation()
          Get Job name, user, number from the message Use when the message is a CPC1221 message Returns null if it is not a CPC1221 message
 SystemMessage getSystemMessage()
          Convert this host message to a locally displayable message in Eclipse
 int getType()
           
 boolean isTransient()
           
 void setRemoteCommandContext(IRemoteCommandContext context)
          Set the context for the remote object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

ISeriesMessage

public ISeriesMessage(QSYSServiceSystemMessage qsysSystemMessage)
Constructor for ISeriesMessage

Method Detail

getAbsoluteName

public String getAbsoluteName()
From base class.

Return the absolute object name, which should be the same as calling getAbsoluteName on this object's remote adapter.

Same as getMessageID().

We return the message ID.


getAdapter

public Object getAdapter(Class adapterType)
See Also:
IAdaptable#getAdapter(Class)

getMessageText

public String getMessageText()
Retrieve the message text


getMessageHelp

public String getMessageHelp()
Retrieve the message help


getMessageID

public String getMessageID()
Retrieve the message id


getMessageType

public String getMessageType()
Retrieve the message type as a translated string


getMessageSeverity

public String getMessageSeverity()
Retrieve the message severity


getMessageSeverityInt

public int getMessageSeverityInt()
Retrieve the message severity as an integer


getMessage

public String getMessage()
See Also:
ISystemMessageObject#getMessage()

getType

public int getType()
See Also:
ISystemMessageObject#getType()

getParent

public Object getParent()
See Also:
ISystemMessageObject#getParent()

isTransient

public boolean isTransient()
See Also:
ISystemMessageObject#isTransient()

getSystemMessage

public SystemMessage getSystemMessage()
Convert this host message to a locally displayable message in Eclipse


displaySystemMessage

public void displaySystemMessage(Shell shell)
Display this host message as a locally displayable message in Eclipse


getSubmittedJobInformation

public ISeriesJobName getSubmittedJobInformation()
Get Job name, user, number from the message Use when the message is a CPC1221 message Returns null if it is not a CPC1221 message


getRemoteCommandContext

public IRemoteCommandContext getRemoteCommandContext()
Description copied from interface: IRemoteCommandContextProvider
Get the remote context.

Specified by:
getRemoteCommandContext in interface IRemoteCommandContextProvider

setRemoteCommandContext

public void setRemoteCommandContext(IRemoteCommandContext context)
Set the context for the remote object

Specified by:
setRemoteCommandContext in interface IRemoteCommandContextProvider

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.