ReplyBuilder (Maximo API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- java.util.AbstractMap
- - java.util.HashMap
  - - com.ibm.json.java.JSONObject
    - - com.ibm.tivoli.maximo.miniapps.treegrid.BaseJSONBuilder
      - com.ibm.tivoli.maximo.miniapps.treegrid.UIBuilder
        
        com.ibm.tivoli.maximo.miniapps.treegrid.ChangesBuilder
        
        com.ibm.tivoli.maximo.miniapps.treegrid.ReplyBuilder

All Implemented Interfaces:

com.ibm.json.java.JSONArtifact, java.io.Serializable, java.lang.Cloneable, java.util.Map
```
public class ReplyBuilder
extends ChangesBuilder
```
Simple class to create a new TreeGrid Reply Object. A TreeGrid reply can contain UPDATES to rows, and even new rows. addChange() is used to UPDATE existing client side records, while addNewRow() is used to add rows to the client side model does not currently exist.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry, java.util.AbstractMap.SimpleImmutableEntry
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry

Field Summary

Fields
Modifier and Type	Field and Description
`static ReplyBuilder`	`OK_INSTANCE_READONLY` Single Instance of the ReplyBuilder that can be shared for a simple OK reply.
`static ReplyBuilder`	`OK_PROCESS_SYNC_REQUESTS_READONLY` Single Instance of the ReplyBuilder that can be shared for a simple OK that will send another request to ther server to process any outstanding SYNC events in the Maximo UI.
`static ReplyBuilder`	`OK_RELOAD_MODEL_INSTANCE_READONLY` Single Instance of the ReplyBuilder that can be shared for a simple OK that will request a model data reload reply.

Fields inherited from class com.ibm.tivoli.maximo.miniapps.treegrid.UIBuilder
Code

Constructor Summary

Constructors
Constructor and Description

ReplyBuilder()

ReplyBuilder(int result)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.ibm.json.java.JSONObject`	`IO()`
`static com.ibm.json.java.JSONObject`	`newErrorReply(java.lang.String msg)`
`static com.ibm.json.java.JSONObject`	`newErrorReply(java.lang.String msg, java.lang.Throwable e)` Creates an Error Reply

Methods inherited from class com.ibm.tivoli.maximo.miniapps.treegrid.ChangesBuilder
addChange, addChange, addChange, addDeleted, addDeleted, addNewRow, addNewRow, addNewRow, Changes, findChange

Methods inherited from class com.ibm.tivoli.maximo.miniapps.treegrid.UIBuilder
Actions, addCol, addCol, addCol, addCol, addDef, addGantt, addGantt, addLeftCol, addLeftCol, addLeftCol, addPager, addRightCol, addRightCol, addRightCol, addRow, addSolid, addZoom, Body, Calendars, Cfg, Cols, Def, Filter, Format, Gantt, getSolid, Head, Header, Lang, LeftCols, Pager, Pagers, Panel, RightCols, Solid, Toolbar, Zoom

Methods inherited from class com.ibm.tivoli.maximo.miniapps.treegrid.BaseJSONBuilder
array, array, getAsType, newArrayObject, object, object, setValue

Methods inherited from class com.ibm.json.java.JSONObject
isValidObject, isValidType, parse, parse, parse, put, serialize, serialize, serialize, serialize, serialize, serialize, toString

Methods inherited from class java.util.HashMap
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap
equals, hashCode

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
equals, hashCode

- Field Detail
  - OK_INSTANCE_READONLY
```
public static final ReplyBuilder OK_INSTANCE_READONLY
```
    Single Instance of the ReplyBuilder that can be shared for a simple OK reply. Do NOT modify this instance!
  - OK_RELOAD_MODEL_INSTANCE_READONLY
```
public static final ReplyBuilder OK_RELOAD_MODEL_INSTANCE_READONLY
```
    Single Instance of the ReplyBuilder that can be shared for a simple OK that will request a model data reload reply. Do NOT modify this instance!
  - OK_PROCESS_SYNC_REQUESTS_READONLY
```
public static final ReplyBuilder OK_PROCESS_SYNC_REQUESTS_READONLY
```
    Single Instance of the ReplyBuilder that can be shared for a simple OK that will send another request to ther server to process any outstanding SYNC events in the Maximo UI. reply. Do NOT modify this instance!
- Constructor Detail
  - ReplyBuilder
```
public ReplyBuilder()
```
  - ReplyBuilder
```
public ReplyBuilder(int result)
```
- Method Detail
  - newErrorReply
```
public static com.ibm.json.java.JSONObject newErrorReply(java.lang.String msg,
                                                         java.lang.Throwable e)
```
    Creates an Error Reply
    
    Parameters:
    
    msg -
    
    e -
    
    Returns:
  - newErrorReply
```
public static com.ibm.json.java.JSONObject newErrorReply(java.lang.String msg)
```
  - IO
```
public com.ibm.json.java.JSONObject IO()
```