Class finesse.restservices.ECCVariableConfig
JavaScript representation of a ECCVariableConfig object. Also exposes methods to operate
on the object against the server.
Defined in: finesse.js.
Constructor Attributes | Constructor Name and Description |
---|---|
finesse.restservices.ECCVariableConfig(id, callbacks)
|
Field Attributes | Field Name and Description |
---|---|
Returns whether this object supports subscriptions
|
Method Attributes | Method Name and Description |
---|---|
get()
Retrieve the ECCVariableConfig settings.
|
|
Gets the REST class for the current object - this is the
ECCVariableConfig object.
|
|
Gets the REST type for the current object - this is a
"ECCVariableConfig".
|
|
Overrides the parent class.
|
Class Detail
finesse.restservices.ECCVariableConfig(id, callbacks)
- Parameters:
- {String} id
- Not required...
- {Object} callbacks
- An object containing callbacks for instantiation and runtime
- {Function} callbacks.onLoad(this)
- Callback to invoke upon successful instantiation
- {Function} callbacks.onLoadError(rsp)
- Callback to invoke on instantiation REST request error as passed by finesse.clientservices.ClientServices.ajax() { 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 error.errorType: {String} Type of error that was caught error.errorMessage: {String} Message associated with error }
- {Function} callbacks.onChange(this)
- Callback to invoke upon successful update
- {Function} callbacks.onError(rsp)
- Callback to invoke on update error (refresh or event) as passed by finesse.clientservices.ClientServices.ajax() { 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 error.errorType: {String} Type of error that was caught error.errorMessage: {String} Message associated with error }
Field Detail
supportsSubscriptions
Returns whether this object supports subscriptions
Method Detail
{ECCVariableConfig}
get()
Retrieve the ECCVariableConfig settings.
- Returns:
- {ECCVariableConfig} This ECCVariableConfig object to allow cascading.
getRestClass()
Gets the REST class for the current object - this is the
ECCVariableConfig object.
getRestType()
Gets the REST type for the current object - this is a
"ECCVariableConfig".
{String}
getRestUrl()
Overrides the parent class. Returns the url for the
ECCVariableConfig resource.
- Returns:
- {String}