National Oceanic and
Atmospheric Administration
United States Department of Commerce

LASResponse JSDoc

Last modified: Mon, 04/03/2017 - 17:29
API for the LASResponse javascript component.

Class LASResponse

Object | +--LASResponse

class LASResponse

This is the basic LASResponse class. Defined in LASResponse.js

Field Summary
 Object response
          
 

Constructor Summary
LASResponse (<object> JSONObject)
            Constructs a new LASResponse object.
The LASResponse object contains all the information returned from the LAS product server.

 

Method Summary
 string getDate()
           Returns the Date the LASResponse was generated.
 string getDebugURL()
           Returns the 'url' attribute associated with the 'plot_image' Result or null if not found.
 string getID()
           Returns the ID associated with the overall LASResponse.
 string getImageURL()
           Returns the 'url' attribute associated with the 'plot_image' Result or null if not found.
 string getMapScaleURL()
           Returns the 'url' attribute associated with the 'plot_image' Result or null if not found.
 object getResult(ID)
           Returns the Result object matching ID or null if the specified ID is not found.
 string getRSSURL()
           Returns the 'url' attribute associated with the 'plot_image' Result or null if not found.
 int isError()
           Returns 1 if response.ID == 'error_response' or if any result has (type == 'error'), 0 otherwise.

Field Detail

response

Object response

    Constructor Detail

    LASResponse

    LASResponse(<object> JSONObject)

      Constructs a new LASResponse object.
      The LASResponse object contains all the information returned from the LAS product server. An XML representation of the JSON object returned by the LAS product server would look like this: 
     + ...

    The LASResponse class defined here provides accessor methods that allow one to get individual pieces of information without navigating the hierarchy.

      Parameters:
        JSONObject - instantiated from JSON serialization of the LASResponse

      Returns:
        A new LASResponse object

    Method Detail

    getDate

    string getDate()

      Returns the Date the LASResponse was generated.

      Returns:
        date the date the LASResponse was generated

    getDebugURL

    string getDebugURL()

      Returns the 'url' attribute associated with the 'plot_image' Result or null if not found.

      Returns:
        url the url associated with the LASResponse

    getID

    string getID()

      Returns the ID associated with the overall LASResponse. Upon success this will correspond to the Operation ID specified in the LASRequest.

      Returns:
        ID the ID associated with the LASResponse

    getImageURL

    string getImageURL()

      Returns the 'url' attribute associated with the 'plot_image' Result or null if not found.

      Returns:
        url the url associated with the LASResponse

    getMapScaleURL

    string getMapScaleURL()

      Returns the 'url' attribute associated with the 'plot_image' Result or null if not found.

      Returns:
        url the url associated with the LASResponse

    getResult

    object getResult(ID)

      Returns the Result object matching ID or null if the specified ID is not found.

      Parameters:
        ID - ID attribute to match

      Returns:
        Result object from the result array

    getRSSURL

    string getRSSURL()

      Returns the 'url' attribute associated with the 'plot_image' Result or null if not found.

      Returns:
        url the url associated with the LASResponse

    isError

    int isError()

      Returns 1 if response.ID == 'error_response' or if any result has (type == 'error'), 0 otherwise.

      Returns:
        isError state of the LASResponse


    Documentation generated by JSDoc on Sat Jul 28 07:25:05 2007