Class Index | File Index

Classes


Class finesse.restservices.TeamWrapUpReasons

JavaScript representation of a TeamWrapUpReasons collection object. Also exposes methods to operate on the object against the server.
Defined in: TeamWrapUpReasons.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
createPutSuccessHandler(wrapUpReasons, contentBody, successHandler)
Set up the PutSuccessHandler for TeamWrapUpReasons
 
get()
Retrieve the Team Wrap Up Reasons.
 
update(newValues, handlers)
Perform the REST API PUT call to update the reason code assignments for the team
Class Detail
finesse.restservices.TeamWrapUpReasons(options)
Parameters:
{Object} options
An object with the following properties:
  • id: The id of the object being constructed
  • onLoad(this): (optional) when the object is successfully loaded from the server
  • onChange(this): (optional) when an update notification of the object is received
  • onAdd(this): (optional) when a notification that the object is created is received
  • onDelete(this): (optional) when a notification that the object is deleted is received
  • onError(rsp): (optional) if loading of the object fails, invoked with the error response object:
    • status: {Number} The HTTP status code returned
    • content: {String} Raw string of response
    • object: {Object} Parsed object of response
    • error: {Object} Wrapped exception that was caught:
      • errorType: {String} Type of error that was caught
      • errorMessage: {String} Message associated with error
  • parentObj: (optional) The parent object
Method Detail
createPutSuccessHandler(wrapUpReasons, contentBody, successHandler)
Set up the PutSuccessHandler for TeamWrapUpReasons
Parameters:
{Object} wrapUpReasons
{Object} contentBody
successHandler
Returns:
response

{finesse.restservices.TeamWrapUpReasons} get()
Retrieve the Team Wrap Up Reasons.
Returns:
{finesse.restservices.TeamWrapUpReasons} This TeamWrapUpReasons object to allow cascading.

{Object} update(newValues, handlers)
Perform the REST API PUT call to update the reason code assignments for the team
Parameters:
{String Array} newValues
handlers
Returns:
{Object} this

Documentation generated by JsDoc Toolkit 2.3.2 on Wed Jul 24 2013 18:47:09 GMT-0400 (EDT)