Maximo 7.6.1.2 API - MaxMessage

java.lang.Object
- psdi.util.CachedObjectPointer
- - psdi.mbo.MaxMessage

All Implemented Interfaces:

java.io.Serializable
```
public class MaxMessage
extends CachedObjectPointer
implements java.io.Serializable
```
The class represent a MAXMESSAGES in a certain language.

Author:

wang

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MaxMessage(java.lang.String language)
Construct the object.

Constructors
Constructor and Description
`MaxMessage(java.lang.String language)` Construct the object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Clone the object.
`java.lang.String`	`getButtonText()` Get the button text.
`java.lang.String`	`getCacheName()`
`java.lang.String`	`getDisplaymethod()` Get the display method.
`java.lang.String`	`getGroup()` Get the message group.
`java.lang.String`	`getId()` Get tms message id
`java.lang.String`	`getKey()` Get the message key
`java.lang.String`	`getLanguage()` Get the language of this maxmessage.
`java.lang.String`	`getMessage()` Get the message based on the value of this MaxMessage
`java.lang.String`	`getMessage(java.lang.Object param)` Get the message based on the value of this MaxMessage
`java.lang.String`	`getMessage(java.lang.Object[] params)` Get the message based on the value of this MaxMessage
`psdi.mbo.MaxMessageBase.MLInsensitivePart`	`getMLInsensitivePart()` Get the object which holds the language insensitive information of this maxmessage.
`int`	`getOptions()` Get the option of the message.
`MaxMessageBase`	`getReference()`
`java.lang.String`	`getTaggedMessage()`
`java.lang.String`	`getTaggedMessage(java.lang.Object param)`
`java.lang.String`	`getTaggedMessage(java.lang.Object[] params)`
`java.lang.String`	`getValue()` Get the message text.
`boolean`	`isPrefix()`
`void`	`setButtonText(java.lang.String btInput)` Set the button text.
`void`	`setDisplayMethod(java.lang.String method)` Set the display method.
`void`	`setGroup(java.lang.String groupInput)` Get the message group.
`void`	`setId(java.lang.String id)` Set the tms message id
`void`	`setKey(java.lang.String keyInput)` Sets the message key.
`void`	`setLanguage(java.lang.String language)` Set the language code.
`void`	`setMLInsensitivePart(psdi.mbo.MaxMessageBase.MLInsensitivePart obj)` Set the object which holds the language insensitive information of this maxmessage.
`void`	`setOptions(int op)` Set the option
`void`	`setPrefix(boolean prefix)`
`void`	`setValue(java.lang.String msg)` Set the text of the message.

Methods inherited from class psdi.util.CachedObjectPointer
getClonedInfo, getID, getParent, getReference, getReferenceForSet, isSameTenantAsReference, setID, setParent, setReference, setTenantReference

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MaxMessage
```
public MaxMessage(java.lang.String language)
```
    Construct the object.
    
    Parameters:
    
    language -
- Method Detail
  - setKey
```
public void setKey(java.lang.String keyInput)
```
    Sets the message key.
    
    Parameters:
    
    keyInput - the string of message key
  - getKey
```
public java.lang.String getKey()
```
    Get the message key
    
    Returns:
    
    The string of message key.
  - setGroup
```
public void setGroup(java.lang.String groupInput)
```
    Get the message group.
    
    Parameters:
    
    groupInput - The string of message group.
  - getGroup
```
public java.lang.String getGroup()
```
    Get the message group.
    
    Returns:
    
    The string of message group.
  - setId
```
public void setId(java.lang.String id)
```
    Set the tms message id
    
    Parameters:
    
    id -
  - getId
```
public java.lang.String getId()
```
    Get tms message id
    
    Returns:
  - setValue
```
public void setValue(java.lang.String msg)
```
    Set the text of the message.
    
    Parameters:
    
    msg - The message text.
  - getValue
```
public java.lang.String getValue()
```
    Get the message text.
    
    Returns:
    
    The message text.
  - setOptions
```
public void setOptions(int op)
```
    Set the option
    
    Parameters:
    
    op - The integer to represent option.
  - getOptions
```
public int getOptions()
```
    Get the option of the message.
    
    Returns:
    
    A integer to represent the option
  - setButtonText
```
public void setButtonText(java.lang.String btInput)
```
    Set the button text.
    
    Parameters:
    
    btInput - the button text.
  - getButtonText
```
public java.lang.String getButtonText()
```
    Get the button text.
    
    Returns:
    
    The button text.
  - setDisplayMethod
```
public void setDisplayMethod(java.lang.String method)
```
    Set the display method.
    
    Parameters:
    
    method - display method code.
  - getDisplaymethod
```
public java.lang.String getDisplaymethod()
```
    Get the display method.
    
    Returns:
    
    the display method code.
  - getLanguage
```
public java.lang.String getLanguage()
```
    Get the language of this maxmessage.
    
    Returns:
  - setLanguage
```
public void setLanguage(java.lang.String language)
```
    Set the language code.
    
    Parameters:
    
    language - The language code of iso 639-2 code.
  - getMLInsensitivePart
```
public psdi.mbo.MaxMessageBase.MLInsensitivePart getMLInsensitivePart()
```
    Get the object which holds the language insensitive information of this maxmessage.
    
    Returns:
    
    A MLInsensitivePart object.
  - setMLInsensitivePart
```
public void setMLInsensitivePart(psdi.mbo.MaxMessageBase.MLInsensitivePart obj)
```
    Set the object which holds the language insensitive information of this maxmessage.
    
    Parameters:
    
    obj - MLInsensitivePart object.
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Clone the object.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - getMessage
```
public java.lang.String getMessage()
```
    Get the message based on the value of this MaxMessage
    
    Returns:
  - getTaggedMessage
```
public java.lang.String getTaggedMessage()
```
  - getMessage
```
public java.lang.String getMessage(java.lang.Object param)
```
    Get the message based on the value of this MaxMessage
    
    Returns:
  - getTaggedMessage
```
public java.lang.String getTaggedMessage(java.lang.Object param)
```
  - getMessage
```
public java.lang.String getMessage(java.lang.Object[] params)
```
    Get the message based on the value of this MaxMessage
    
    Returns:
  - getTaggedMessage
```
public java.lang.String getTaggedMessage(java.lang.Object[] params)
```
  - isPrefix
```
public boolean isPrefix()
```
  - setPrefix
```
public void setPrefix(boolean prefix)
```
  - getReference
```
public MaxMessageBase getReference()
```
  - getCacheName
```
public java.lang.String getCacheName()
```
    Overrides:
    
    getCacheName in class CachedObjectPointer

Class MaxMessage

Constructor Summary

Method Summary

Methods inherited from class psdi.util.CachedObjectPointer

Methods inherited from class java.lang.Object

Constructor Detail

MaxMessage

Method Detail

setKey

getKey

setGroup

getGroup

setId

getId

setValue

getValue

setOptions

getOptions

setButtonText

getButtonText

setDisplayMethod

getDisplaymethod

getLanguage

setLanguage

getMLInsensitivePart

setMLInsensitivePart

clone

getMessage

getTaggedMessage

getMessage

getTaggedMessage

getMessage

getTaggedMessage

isPrefix

setPrefix

getReference

getCacheName