JSONResultSetRow

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap
  - - com.ibm.json.java.JSONObject
    - - com.ibm.ecm.json.JSONResultSetRow

All Implemented Interfaces:

com.ibm.json.java.JSONArtifact, java.io.Serializable, java.lang.Cloneable, java.util.Map
```
public class JSONResultSetRow
extends com.ibm.json.java.JSONObject
```
This class represents a single row in a result set. A row typically represents a "hit" for a search or item within a folder or work list.

Since:

2.0.2

See Also:

Serialized Form

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

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`PRIV_ADD_LINK` Privilege constant on an item indicating that links can be added to the item
`static long`	`PRIV_ADD_TO_FOLDER` Privilege constant on folders indicating that the folder can have items added to it
`static long`	`PRIV_ADDDOC` Privilege constant indicating that documents can be added
`static long`	`PRIV_ADDITEM` Privilege constant indicating non-document items can be added
`static long`	`PRIV_ADDNOTES` Privilege constant indicating indicating that notes can be added to an item
`static long`	`PRIV_CANCELCHECKOUTDOC` Privilege constant indicating that the document checkout can be cancelled.
`static long`	`PRIV_CHANGE_CLASS` Privilege constant indicating that the content class of the item can be changed.
`static long`	`PRIV_CHECKINDOC` Privilege constant indicating that the document can be checked in.
`static long`	`PRIV_CHECKINOUTDOC` Privilege constant indicating that the document supports checkin and checkout.
`static long`	`PRIV_CHECKOUTDOC` Privilege constant indicating that the document can be checked out.
`static long`	`PRIV_DECLARE` Privilege constant indicating that the document can be declared in a record.
`static long`	`PRIV_DELETE` Privilege constant indicating that the document can be deleted.
`static long`	`PRIV_EDITANNOTATIONS` Privilege constant indicating that annotations can be edited on the document.
`static long`	`PRIV_EDITDOC` Privilege constant indicating the item's content can be edited
`static long`	`PRIV_EDITPROPERTIES` Privilege constant indicating properties of the item can be edited
`static long`	`PRIV_EMAILDOC` Privilege constant indicating the document can be emailed.
`static long`	`PRIV_EXPORT` Privilege constant indicating the document can be exported (downloaded)
`static long`	`PRIV_HOLD` Privilege constant indicating that the document can be put on hold.
`static long`	`PRIV_MAJOR_VERSION` Privilege constant indicating that the document can be major versioned.
`static long`	`PRIV_MINOR_VERSION` Privilege constant indicating that the document can be minor versioned
`static long`	`PRIV_MODIFYNOTES` Privilege constant indicating that notes can be modified on the document.
`static long`	`PRIV_MOVE_TO_FOLDER` Privilege constant indicating that the item can be moved from one folder to another.
`static long`	`PRIV_PRINTDOC` Privilege constant indicating that the document can be printed
`static long`	`PRIV_PRINTNOTES` Privilege constant indicating that notes can be printed
`static long`	`PRIV_REMOVE_FROM_FOLDER` Privilege constant on a folder indicating that items can be removed from it
`static long`	`PRIV_REMOVE_LINK` Privilege constant on an item indicating that links can be removed from the item
`static long`	`PRIV_STARTWORKFLOW` Privilege constant indicating that the document can be started on workflow.
`static long`	`PRIV_VIEWANNOTATIONS` Privilege constant indicating that annotations can be viewed on the document.
`static long`	`PRIV_VIEWDOC` Privilege constant indicating that the document can be viewed.
`static long`	`PRIV_VIEWNOTES` Privilege constant indicating notes on the item can be viewed
`static java.lang.String`	`TYPE_BINARY` Data type constant for binary data
`static java.lang.String`	`TYPE_BOOLEAN` Data type constant for boolean
`static java.lang.String`	`TYPE_DOUBLE` Data type constant for floating point
`static java.lang.String`	`TYPE_GUID` Data type constant for an GUID
`static java.lang.String`	`TYPE_INTEGER` Data type constant for integer
`static java.lang.String`	`TYPE_OBJECT` Data type constant for a complex object
`static java.lang.String`	`TYPE_STRING` Data type constant for string
`static java.lang.String`	`TYPE_TIMESTAMP` Data type constant for date, time, timestamp

Constructor Summary

Constructors
Constructor and Description
`JSONResultSetRow()` Default constructor.
`JSONResultSetRow(java.lang.String id, java.lang.String name, java.lang.String mimetype, long privileges)` Constructor
`JSONResultSetRow(java.lang.String template, java.lang.String id, java.lang.String name, java.lang.String mimetype, long privileges)` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttribute(java.lang.String id, java.lang.Object value, java.lang.String type, java.lang.String format, java.lang.String displayValue)` Adds an attribute to the row.
`int`	`getAttributeCount()` Returns the number of attributes on the row.
`java.lang.String`	`getAttributeDisplayValue(java.lang.String id)` Returns the display value of an attribute given the attribute id.
`java.lang.String`	`getAttributeFormat(java.lang.String id)` Returns the format of an attribute given the attribute id.
`java.lang.String`	`getAttributeType(java.lang.String id)` Returns the type of an attribute given the attribute id.
`java.lang.Object`	`getAttributeValue(java.lang.String id)` Returns the value of an attribute given the attribute id.
`java.lang.String`	`getId()` Returns the internal identifier for the item represented by this row.
`void`	`getId(java.lang.String id)` Sets the internal identifier for the item represented by this row.
`java.lang.String`	`getMimetype()` Returns the MIME content type of the item represented by the row.
`java.lang.String`	`getName()` Returns the name of the item represented by this row.
`long`	`getPrivileges()` Returns a bitmapped integer containing the privileges the user has on this item.
`void`	`setAttributeDisplayValue(java.lang.String id, java.lang.String displayValue)` Sets the display value of an attribute.
`void`	`setAttributeFormat(java.lang.String id, java.lang.String format)` Sets the format of an attribute.
`void`	`setAttributeType(java.lang.String id, java.lang.String type)` Sets the type of an attribute.
`void`	`setAttributeValue(java.lang.String id, java.lang.Object value)` Sets the value of an attribute.
`void`	`setMimetype(java.lang.String mimetype)` Sets the MIME content type of the item represented by this row.
`void`	`setName(java.lang.String name)` Sets the name of the item represented by this row.
`void`	`setPrivileges(long privileges)` Sets the bitmapped integer containing the privileges the user has on this item.
`static JSONResultSetRow`	`toJSONResultSetRow(com.ibm.json.java.JSONObject jsonObject)` This is for compatibility with earlier JSON that did not use this class.

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
  - PRIV_EDITPROPERTIES
```
public static final long PRIV_EDITPROPERTIES
```
    Privilege constant indicating properties of the item can be edited
    
    See Also:
    
    Constant Field Values
  - PRIV_EDITDOC
```
public static final long PRIV_EDITDOC
```
    Privilege constant indicating the item's content can be edited
    
    See Also:
    
    Constant Field Values
  - PRIV_VIEWNOTES
```
public static final long PRIV_VIEWNOTES
```
    Privilege constant indicating notes on the item can be viewed
    
    See Also:
    
    Constant Field Values
  - PRIV_ADDDOC
```
public static final long PRIV_ADDDOC
```
    Privilege constant indicating that documents can be added
    
    See Also:
    
    Constant Field Values
  - PRIV_ADDITEM
```
public static final long PRIV_ADDITEM
```
    Privilege constant indicating non-document items can be added
    
    See Also:
    
    Constant Field Values
  - PRIV_EMAILDOC
```
public static final long PRIV_EMAILDOC
```
    Privilege constant indicating the document can be emailed.
    
    See Also:
    
    Constant Field Values
  - PRIV_EXPORT
```
public static final long PRIV_EXPORT
```
    Privilege constant indicating the document can be exported (downloaded)
    
    See Also:
    
    Constant Field Values
  - PRIV_ADD_TO_FOLDER
```
public static final long PRIV_ADD_TO_FOLDER
```
    Privilege constant on folders indicating that the folder can have items added to it
    
    See Also:
    
    Constant Field Values
  - PRIV_REMOVE_FROM_FOLDER
```
public static final long PRIV_REMOVE_FROM_FOLDER
```
    Privilege constant on a folder indicating that items can be removed from it
    
    See Also:
    
    Constant Field Values
  - PRIV_ADD_LINK
```
public static final long PRIV_ADD_LINK
```
    Privilege constant on an item indicating that links can be added to the item
    
    See Also:
    
    Constant Field Values
  - PRIV_REMOVE_LINK
```
public static final long PRIV_REMOVE_LINK
```
    Privilege constant on an item indicating that links can be removed from the item
    
    See Also:
    
    Constant Field Values
  - PRIV_ADDNOTES
```
public static final long PRIV_ADDNOTES
```
    Privilege constant indicating indicating that notes can be added to an item
    
    See Also:
    
    Constant Field Values
  - PRIV_PRINTNOTES
```
public static final long PRIV_PRINTNOTES
```
    Privilege constant indicating that notes can be printed
    
    See Also:
    
    Constant Field Values
  - PRIV_PRINTDOC
```
public static final long PRIV_PRINTDOC
```
    Privilege constant indicating that the document can be printed
    
    See Also:
    
    Constant Field Values
  - PRIV_CHECKINOUTDOC
```
public static final long PRIV_CHECKINOUTDOC
```
    Privilege constant indicating that the document supports checkin and checkout.
    
    See Also:
    
    Constant Field Values
  - PRIV_CHECKINDOC
```
public static final long PRIV_CHECKINDOC
```
    Privilege constant indicating that the document can be checked in.
    
    See Also:
    
    Constant Field Values
  - PRIV_CHECKOUTDOC
```
public static final long PRIV_CHECKOUTDOC
```
    Privilege constant indicating that the document can be checked out.
    
    See Also:
    
    Constant Field Values
  - PRIV_CANCELCHECKOUTDOC
```
public static final long PRIV_CANCELCHECKOUTDOC
```
    Privilege constant indicating that the document checkout can be cancelled.
    
    See Also:
    
    Constant Field Values
  - PRIV_VIEWANNOTATIONS
```
public static final long PRIV_VIEWANNOTATIONS
```
    Privilege constant indicating that annotations can be viewed on the document.
    
    See Also:
    
    Constant Field Values
  - PRIV_EDITANNOTATIONS
```
public static final long PRIV_EDITANNOTATIONS
```
    Privilege constant indicating that annotations can be edited on the document.
    
    See Also:
    
    Constant Field Values
  - PRIV_VIEWDOC
```
public static final long PRIV_VIEWDOC
```
    Privilege constant indicating that the document can be viewed.
    
    See Also:
    
    Constant Field Values
  - PRIV_DELETE
```
public static final long PRIV_DELETE
```
    Privilege constant indicating that the document can be deleted.
    
    See Also:
    
    Constant Field Values
  - PRIV_STARTWORKFLOW
```
public static final long PRIV_STARTWORKFLOW
```
    Privilege constant indicating that the document can be started on workflow.
    
    See Also:
    
    Constant Field Values
  - PRIV_HOLD
```
public static final long PRIV_HOLD
```
    Privilege constant indicating that the document can be put on hold.
    
    See Also:
    
    Constant Field Values
  - PRIV_MOVE_TO_FOLDER
```
public static final long PRIV_MOVE_TO_FOLDER
```
    Privilege constant indicating that the item can be moved from one folder to another.
    
    See Also:
    
    Constant Field Values
  - PRIV_CHANGE_CLASS
```
public static final long PRIV_CHANGE_CLASS
```
    Privilege constant indicating that the content class of the item can be changed.
    
    See Also:
    
    Constant Field Values
  - PRIV_MAJOR_VERSION
```
public static final long PRIV_MAJOR_VERSION
```
    Privilege constant indicating that the document can be major versioned.
    
    See Also:
    
    Constant Field Values
  - PRIV_MINOR_VERSION
```
public static final long PRIV_MINOR_VERSION
```
    Privilege constant indicating that the document can be minor versioned
    
    See Also:
    
    Constant Field Values
  - PRIV_DECLARE
```
public static final long PRIV_DECLARE
```
    Privilege constant indicating that the document can be declared in a record.
    
    See Also:
    
    Constant Field Values
  - PRIV_MODIFYNOTES
```
public static final long PRIV_MODIFYNOTES
```
    Privilege constant indicating that notes can be modified on the document.
    
    See Also:
    
    Constant Field Values
  - TYPE_STRING
```
public static final java.lang.String TYPE_STRING
```
    Data type constant for string
    
    See Also:
    
    Constant Field Values
  - TYPE_BOOLEAN
```
public static final java.lang.String TYPE_BOOLEAN
```
    Data type constant for boolean
    
    See Also:
    
    Constant Field Values
  - TYPE_TIMESTAMP
```
public static final java.lang.String TYPE_TIMESTAMP
```
    Data type constant for date, time, timestamp
    
    See Also:
    
    Constant Field Values
  - TYPE_DOUBLE
```
public static final java.lang.String TYPE_DOUBLE
```
    Data type constant for floating point
    
    See Also:
    
    Constant Field Values
  - TYPE_INTEGER
```
public static final java.lang.String TYPE_INTEGER
```
    Data type constant for integer
    
    See Also:
    
    Constant Field Values
  - TYPE_OBJECT
```
public static final java.lang.String TYPE_OBJECT
```
    Data type constant for a complex object
    
    See Also:
    
    Constant Field Values
  - TYPE_BINARY
```
public static final java.lang.String TYPE_BINARY
```
    Data type constant for binary data
    
    See Also:
    
    Constant Field Values
  - TYPE_GUID
```
public static final java.lang.String TYPE_GUID
```
    Data type constant for an GUID
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JSONResultSetRow
```
public JSONResultSetRow()
```
    Default constructor. This constructor in public to be available internally and should not normally be used by plug-ins.
  - JSONResultSetRow
```
public JSONResultSetRow(java.lang.String id,
                        java.lang.String name,
                        java.lang.String mimetype,
                        long privileges)
```
    Constructor
    
    Parameters:
    
    id - the id of the row. This is an internal identifier used on other requests for the item represented by this row.
    
    name - the name of the item represented by this row. The name is displayed in tree views and other locations to name the item.
    
    mimetype - the MIME content type of the item represented by the row. For non-content items, special values are used for mimetype to indicate the type of the item.
    
    privileges - a bitmapped integer containing the privileges the user has on this item. See the PRIV_ statics for the definition of the different bits.
  - JSONResultSetRow
```
public JSONResultSetRow(java.lang.String template,
                        java.lang.String id,
                        java.lang.String name,
                        java.lang.String mimetype,
                        long privileges)
```
    Constructor
    
    Parameters:
    
    template - the name of the class type for this item.
    
    id - the id of the row. This is an internal identifier used on other requests for the item represented by this row.
    
    name - the name of the item represented by this row. The name is displayed in tree views and other locations to name the item.
    
    mimetype - the MIME content type of the item represented by the row. For non-content items, special values are used for mimetype to indicate the type of the item.
    
    privileges - a bitmapped integer containing the privileges the user has on this item. See the PRIV_ statics for the definition of the different bits.
- Method Detail
  - toJSONResultSetRow
```
public static final JSONResultSetRow toJSONResultSetRow(com.ibm.json.java.JSONObject jsonObject)
```
    This is for compatibility with earlier JSON that did not use this class. It will either return an instance of the argument if it is already a JSONResultSetRow or will construct a JSONResultSetColum from the given JSONObject.
    
    Parameters:
    
    jsonObject -
    
    Returns:
  - getId
```
public java.lang.String getId()
```
    Returns the internal identifier for the item represented by this row.
  - getId
```
public void getId(java.lang.String id)
```
    Sets the internal identifier for the item represented by this row.
  - getName
```
public java.lang.String getName()
```
    Returns the name of the item represented by this row. This is the name that will be displayed on tree views and other locations to name the item.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of the item represented by this row.
  - getMimetype
```
public java.lang.String getMimetype()
```
    Returns the MIME content type of the item represented by the row. For non-content items, special values are used for mimetype to indicate the type of the item.
  - setMimetype
```
public void setMimetype(java.lang.String mimetype)
```
    Sets the MIME content type of the item represented by this row.
  - getPrivileges
```
public long getPrivileges()
```
    Returns a bitmapped integer containing the privileges the user has on this item. See the PRIV_ statics for the definition of the different bits.
  - setPrivileges
```
public void setPrivileges(long privileges)
```
    Sets the bitmapped integer containing the privileges the user has on this item.
  - addAttribute
```
public void addAttribute(java.lang.String id,
                         java.lang.Object value,
                         java.lang.String type,
                         java.lang.String format,
                         java.lang.String displayValue)
```
    Adds an attribute to the row. An attribute corresponds to a cell in the details view of the content list.
    
    Parameters:
    
    id - the identifier of the attribute. This should match the identifier of a result set column to appear in the content list details view.
    
    value - the value of the attribute. This is usually a String but Integer and Boolean are also used for appropriate data types.
    
    type - the type of the attribute. Use the TYPE_ static strings defined in this class for the proper syntax of the type for different data types. These strings are based on XML data type descriptors.
    
    format - the format of the attribute. This is interpreted differently depending on the type. For timestamp types this is an dojo date formatter. Look at the implementation of ecm.model.ValueFormatter for how the format is interpreted. If no format is needed specify null.
    
    displayValue - a string describing how the value should be displayed. This overrides any formatting that would normally occur for the value and it will be displayed using this string. If no overriding display value is needed specify null.
  - getAttributeCount
```
public int getAttributeCount()
```
    Returns the number of attributes on the row.
  - getAttributeValue
```
public java.lang.Object getAttributeValue(java.lang.String id)
```
    Returns the value of an attribute given the attribute id.
    
    Parameters:
    
    id - the identifier of the attribute.
    
    Returns:
    
    an object, typically a String but may be a Boolean or Integer, containing the value, or null if no value is defined for the attribute or the attribute does not exist.
  - setAttributeValue
```
public void setAttributeValue(java.lang.String id,
                              java.lang.Object value)
```
    Sets the value of an attribute. This will add the attribute if it does not exist on the row.
    
    Parameters:
    
    id - the attribute id
    
    value - an object containing the value of the attribute. This is typically a String but may be Boolean or Integer for boolean and integer data types.
  - getAttributeType
```
public java.lang.String getAttributeType(java.lang.String id)
```
    Returns the type of an attribute given the attribute id.
    
    Parameters:
    
    id - the identifier of the attribute.
    
    Returns:
    
    the type of the attribute, one of the TYPE_ constants, or null if the attribute does not have a defined type.
  - setAttributeType
```
public void setAttributeType(java.lang.String id,
                             java.lang.String type)
```
    Sets the type of an attribute. This will add the attribute if it does not exist on the row.
    
    Parameters:
    
    id - the attribute id
    
    type - an string, one of the TYPE_ constants, containing the type of the attribute.
  - getAttributeFormat
```
public java.lang.String getAttributeFormat(java.lang.String id)
```
    Returns the format of an attribute given the attribute id.
    
    Parameters:
    
    id - the identifier of the attribute.
    
    Returns:
    
    the format of the attribute or null if the attribute uses default formatting.
  - setAttributeFormat
```
public void setAttributeFormat(java.lang.String id,
                               java.lang.String format)
```
    Sets the format of an attribute. This will add the attribute if it does not exist on the row.
    
    Parameters:
    
    id - the attribute id
    
    format - a format string or null for default formatting.
  - getAttributeDisplayValue
```
public java.lang.String getAttributeDisplayValue(java.lang.String id)
```
    Returns the display value of an attribute given the attribute id.
    
    Parameters:
    
    id - the identifier of the attribute.
    
    Returns:
    
    the display value of the attribute or null if the attribute does not have a defined display value, in which case the display value will be determined from formatting the value (which is normally the case).
  - setAttributeDisplayValue
```
public void setAttributeDisplayValue(java.lang.String id,
                                     java.lang.String displayValue)
```
    Sets the display value of an attribute. This will add the attribute if it does not exist on the row.
    
    Parameters:
    
    id - the attribute id
    
    displayValue - an string, which will be used as the displayed value for the attribute, or null for default display based on value, type and format.

Class JSONResultSetRow

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.ibm.json.java.JSONObject

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

PRIV_EDITPROPERTIES

PRIV_EDITDOC

PRIV_VIEWNOTES

PRIV_ADDDOC

PRIV_ADDITEM

PRIV_EMAILDOC

PRIV_EXPORT

PRIV_ADD_TO_FOLDER

PRIV_REMOVE_FROM_FOLDER

PRIV_ADD_LINK

PRIV_REMOVE_LINK

PRIV_ADDNOTES

PRIV_PRINTNOTES

PRIV_PRINTDOC

PRIV_CHECKINOUTDOC

PRIV_CHECKINDOC

PRIV_CHECKOUTDOC

PRIV_CANCELCHECKOUTDOC

PRIV_VIEWANNOTATIONS

PRIV_EDITANNOTATIONS

PRIV_VIEWDOC

PRIV_DELETE

PRIV_STARTWORKFLOW

PRIV_HOLD

PRIV_MOVE_TO_FOLDER

PRIV_CHANGE_CLASS

PRIV_MAJOR_VERSION

PRIV_MINOR_VERSION

PRIV_DECLARE

PRIV_MODIFYNOTES

TYPE_STRING

TYPE_BOOLEAN

TYPE_TIMESTAMP

TYPE_DOUBLE

TYPE_INTEGER

TYPE_OBJECT

TYPE_BINARY

TYPE_GUID

Constructor Detail

JSONResultSetRow

JSONResultSetRow

JSONResultSetRow

Method Detail

toJSONResultSetRow

getId

getId

getName

setName

getMimetype

setMimetype

getPrivileges

setPrivileges

addAttribute

getAttributeCount

getAttributeValue

setAttributeValue

getAttributeType

setAttributeType

getAttributeFormat

setAttributeFormat

getAttributeDisplayValue

setAttributeDisplayValue