All Classes Namespaces Files Functions Variables Pages
Static Public Member Functions | List of all members
dx::DXSystem Class Reference

Static functions for searching for objects. More...

#include <search.h>

Static Public Member Functions

static dx::JSON findDataObjects (dx::JSON query)
 
static dx::JSON findOneDataObject (dx::JSON query)
 
static dx::JSON findJobs (dx::JSON query)
 
static dx::JSON findProjects (dx::JSON query)
 
static dx::JSON findApps (dx::JSON query)
 

Detailed Description

Static functions for searching for objects.

This class contains static member functions corresponding to /find* routes.

For your convenience, all methods of the DXSystem class interpret "timestamp" fields in input hashes more loosely then the raw API does. Unlike the raw API, any "timestamp" value may be an integer or a string (the raw API only allows integer values). For all non-negative timestamp values, DXSystem methods behave exactly the way the raw API does. In general:

Member Function Documentation

JSON dx::DXSystem::findApps ( dx::JSON  query)
static

This function is a wrapper around the /system/findApps API method.

Parameters
queryA JSON hash to be provided to /system/findApps.
Returns
A JSON hash as returned by /system/findApps.
Note
  • Timestamp fields in the input query are allowed to be more relaxed than what the raw API expects. See the documentation at top of the DXSystem class for details.
JSON dx::DXSystem::findDataObjects ( dx::JSON  query)
static

This function is a wrapper around the /system/findDataObjects API method.

Parameters
queryA JSON hash to be provided to /system/findDataObjects.
Returns
A JSON hash as returned by /system/findDataObjects.
Note
  • Timestamp fields in the input query are allowed to be more relaxed than what the raw API expects. See the documentation at top of the DXSystem class for details.
  • If input query doesn't have the field "scope", then all private objects are searched. If query["scope"] is supplied but doesn't have the field "project", then it is set to the current Workspace ID (if this is not available, a DXError is thrown).
JSON dx::DXSystem::findJobs ( dx::JSON  query)
static

This function is a wrapper around the /system/findJobs API method.

Parameters
queryA JSON hash to be provided to /system/findJobs.
Returns
A JSON hash as returned by /system/findJobs.
Note
  • Timestamp fields in the input query are allowed to be more relaxed than what the raw API expects. See the documentation at top of the DXSystem class for details.
JSON dx::DXSystem::findOneDataObject ( dx::JSON  query)
static

Exactly the same as findDataObjects(), except that only the first result is returned (or null if there are no results).

See Also
findDataObjects()
Parameters
queryA JSON hash, as expected by findDataObjects().
Returns
If at least one object matched the search criteria, then a JSON_HASH containing the following keys: "id", "project", "describe" (if requested) will be returned. If no object matched the search criteria, then JSON_NULL is returned.
JSON dx::DXSystem::findProjects ( dx::JSON  query)
static

This function is a wrapper around the /system/findProjects API method.

Parameters
queryA JSON hash to be provided to /system/findProjects.
Returns
A JSON hash as returned by /system/findProjects.

The documentation for this class was generated from the following files: