Class Index | File Index

Classes


Class finesse.restservices.TeamAssignment

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

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Getter for the id.
 
Getter for the name.
 
Getter for a NotReadyReasonCodes collection object that is associated with a Team.
 
Getter for a SignOutReasonCodes collection object that is associated with a Team.
 
Getter for the uri.
 
getWrapUpReasons(callbacks)
Getter for a WrapUpReasons collection object that is associated with a Team.
Class Detail
finesse.restservices.TeamAssignment(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
{String} getId()
Getter for the id.
Returns:
{String} The id.

{String} getName()
Getter for the name.
Returns:
{String} The name.

{ReasonCodes} getNotReadyReasonCodes(callbacks)
Getter for a NotReadyReasonCodes collection object that is associated with a Team.
Parameters:
callbacks
Returns:
{ReasonCodes} A Not Ready Reason Codes collection object.

{ReasonCodes} getSignOutReasonCodes(callbacks)
Getter for a SignOutReasonCodes collection object that is associated with a Team.
Parameters:
callbacks
Returns:
{ReasonCodes} A Sign Out Reason Codes collection object.

{String} getUri()
Getter for the uri.
Returns:
{String} The uri.

{WrapUpReasons} getWrapUpReasons(callbacks)
Getter for a WrapUpReasons collection object that is associated with a Team.
Parameters:
callbacks
Returns:
{WrapUpReasons} A Wrap-Up Reasons collection object.

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