com.ibm.tivoli.maximo.fdmbo

Class JSONQuery

  • java.lang.Object
    • com.ibm.tivoli.maximo.fdmbo.JSONQuery

  • public class JSONQuery
extends java.lang.Object
    JSON Query builder.

    • Constructor Summary

      Constructors 
      Constructor and Description
      JSONQuery()
      Constructor
      JSONQuery(java.lang.String query, MboRemote owner)
      Constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void addSort(java.lang.String attr, boolean asc)
      Add order by to existing sort.
      java.lang.String format()
      Formats JSON query.
      java.lang.String getJSONQuery()
      Get formatted JSON query.
      java.lang.String join(com.ibm.json.java.JSONObject jsonQuery2)
      Add more parameters to existing JSON query.
      java.lang.String join(java.lang.String query)
      Add more parameters to existing query.
      void remove(java.lang.String key)
      Remove parameters.
      void setFields(java.util.Set fields)
      Set JSON fields.
      void setLimit(int limit)
      Set limit for paging.
      void setSelectIDField()
      Set ID field.
      void setSkip(int skip)
      Set skip for paging.
      void setSort(com.ibm.json.java.JSONArray orderBy)
      Set sort object.
      void setSort(java.util.Map sortMap)
      Set sort map.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • JSONQuery

        public JSONQuery(java.lang.String query,
                 MboRemote owner)
          throws MXException
        Constructor
        Parameters:
        query - query.
        owner - Owner business object
        Throws:
        MXException

      • JSONQuery

        public JSONQuery()
        Constructor

    • Method Detail

      • format

        public java.lang.String format()
                        throws MXException,
                               java.rmi.RemoteException
        Formats JSON query.
        Returns:
        formatted query
        Throws:
        MXException - Maximo Exception
        java.rmi.RemoteException - Remote Exception

      • join

        public java.lang.String join(java.lang.String query)
                      throws MXException,
                             java.rmi.RemoteException
        Add more parameters to existing query.
        Parameters:
        query - original query string
        Returns:
        new query with more parameters
        Throws:
        MXException - Maximo Exception
        java.rmi.RemoteException - Remote Exception

      • join

        public java.lang.String join(com.ibm.json.java.JSONObject jsonQuery2)
                      throws MXException,
                             java.rmi.RemoteException
        Add more parameters to existing JSON query.
        Parameters:
        query - original query object
        Returns:
        new query with more parameters
        Throws:
        MXException - Maximo Exception
        java.rmi.RemoteException - Remote Exception

      • setLimit

        public void setLimit(int limit)
        Set limit for paging.
        Parameters:
        limit - page limit

      • setSkip

        public void setSkip(int skip)
        Set skip for paging.
        Parameters:
        skip - page records

      • remove

        public void remove(java.lang.String key)
        Remove parameters.
        Parameters:
        key - key to remove

      • setFields

        public void setFields(java.util.Set fields)
        Set JSON fields.
        Parameters:
        fields - set of fields to set

      • setSelectIDField

        public void setSelectIDField()
        Set ID field.

      • setSort

        public void setSort(java.util.Map sortMap)
        Set sort map.
        Parameters:
        sortMap - sort map

      • addSort

        public void addSort(java.lang.String attr,
                    boolean asc)
        Add order by to existing sort.
        Parameters:
        attr - sort field
        asc - ascending or descending

      • setSort

        public void setSort(com.ibm.json.java.JSONArray orderBy)
        Set sort object.
        Parameters:
        orderBy - order by object

      • getJSONQuery

        public java.lang.String getJSONQuery()
                              throws MXException,
                                     java.rmi.RemoteException
        Get formatted JSON query.
        Returns:
        JSON query
        Throws:
        MXException
        java.rmi.RemoteException
Skip navigation links