# Class: AbstractObject

## Gitana. AbstractObject

Abstract base class for Gitana document objects.

#### new AbstractObject(driver, object)

  ##### Parameters:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `driver` | Gitana |  |
  `object` | Object | <optional> |

  Source:
    - AbstractObject.js, line 17

### Extends

- Gitana.AbstractPersistable

### Methods

#### __copyState()

  Override the Chain.__copyState method so that it utilizes a base method that we can override on a per-class basis.

  Inherited From:
    - Gitana.Chainable#__copyState
  Source:
    - Chainable.js, line 25

#### chainCopyState(otherObject)

  Override to include:

  __system

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `otherObject` |  |

  Source:
    - AbstractObject.js, line 149

#### chainCreate(chainable, object, uri, params)

  Creates an object on the server (write + read). Proceeds with the chain as bound to the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `object` |  |
  `uri` |  |
  `params` |  |

  Inherited From:
    - Gitana.Chainable#chainCreate
  Source:
    - Chainable.js, line 135

#### chainCreateEx(chainable, object, createUri, readUri)

  Creates an object on the server using one URL and then reads it back using another URL. This exists because the security responses don't include _doc fields like other responses.

  Proceeds with the chain as bound to the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `object` |  |
  `createUri` |  |
  `readUri` |  |

  Inherited From:
    - Gitana.Chainable#chainCreateEx
  Source:
    - Chainable.js, line 177

#### chainDelete(chainable, uri, params)

  Executes an HTTP delete for this object and continues the chain with the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `uri` |  |
  `params` |  |

  Source:
    - AbstractObject.js, line 43

#### chainGet(chainable, uri, params)

  Performs a GET from the server and populates the chainable. Proceeds with the chain as bound to the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `uri` |  |
  `params` |  |

  Inherited From:
    - Gitana.Chainable#chainGet
  Source:
    - Chainable.js, line 101

#### chainGetResponse(chainable, uri, params)

  Performs a GET to the server and pushes the response into the chain. Proceeds with the chain as bound to the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `uri` |  |
  `params` |  |

  Inherited From:
    - Gitana.Chainable#chainGetResponse
  Source:
    - Chainable.js, line 338

#### chainGetResponseRows(chainable, uri, params)

  Performs a GET to the server and pushes the "rows" response attribute into the chain. Proceeds with the chain as bound to the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `uri` |  |
  `params` |  |

  Inherited From:
    - Gitana.Chainable#chainGetResponseRows
  Source:
    - Chainable.js, line 401

#### chainGetResponseText(chainable, uri, params)

  Performs a GET to the server and pushes the text response to the callback.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `uri` |  |
  `params` |  |

  Inherited From:
    - Gitana.Chainable#chainGetResponseText
  Source:
    - Chainable.js, line 369

#### chainHasResponseRow(chainable, uri, value)

  Performs a GET to the server and checks whether the "rows" array attribute of the response has the given value.

  Proceeds with the chain as bound to the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `uri` |  |
  `value` |  |

  Inherited From:
    - Gitana.Chainable#chainHasResponseRow
  Source:
    - Chainable.js, line 418

#### chainPost(chainable, uri, params, payload)

  Performs a POST to the server and populates the chainable with results. Proceeds with the chain as bound to the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `uri` |  |
  `params` |  |
  `payload` |  |

  Inherited From:
    - Gitana.Chainable#chainPost
  Source:
    - Chainable.js, line 222

#### chainPostEmpty(chainable, uri, params, payload, contentType)

  Performs a POST to the server. The response is not handled. Proceeds with the chain as bound to the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `uri` |  |
  `params` |  |
  `payload` |  | (optional)
  `contentType` |  | (optional) - example "text/plain"

  Inherited From:
    - Gitana.Chainable#chainPostEmpty
  Source:
    - Chainable.js, line 258

#### chainPostResponse(chainable, uri, params)

  Performs a POST to the server and pushes the response into the chain. Proceeds with the chain as bound to the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `uri` |  |
  `params` |  |

  Inherited From:
    - Gitana.Chainable#chainPostResponse
  Source:
    - Chainable.js, line 441

#### chainReload(uri, params)

  Reloads this object from the server and then passes control to the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `uri` |  |
  `params` |  |

  Source:
    - AbstractObject.js, line 74

#### chainUpdate(chainable, uri, params)

  Executes an update (write + read) of this object and then passes control to the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `uri` |  |
  `params` |  |

  Source:
    - AbstractObject.js, line 107

#### chainUpload(chainable, uri, params, contentType, payload)

  Performs a POST to the server. The response is not handled. Proceeds with the chain as bound to the chainable.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `chainable` |  |
  `uri` |  |
  `params` |  |
  `contentType` |  | (optional) - example "text/plain"
  `payload` |  | (optional)

  Inherited From:
    - Gitana.Chainable#chainUpload
  Source:
    - Chainable.js, line 299

#### extractPrincipalDomainQualifiedId(principal)

  Helper to gets the principal id for a principal object, json structure or principal id itself. This returns something like "domainId/principalId"

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `principal` |  |

  Inherited From:
    - Gitana.Chainable#extractPrincipalDomainQualifiedId
  Source:
    - Chainable.js, line 472

#### extractPrincipalIdentifiers(principal, defaultDomainId)

  Helper to gets the principal id for a principal object, json structure or principal id itself. This returns something like "domainId/principalId"

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `principal` |  | principal object or string (principal id or domain qualified principal id)
  `defaultDomainId` |  |

  Inherited From:
    - Gitana.Chainable#extractPrincipalIdentifiers
  Source:
    - Chainable.js, line 486

#### get(key)

  Get a json property

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `key` |  |

  Source:
    - AbstractObject.js, line 198

#### getDescription() → {String}

  The description for the object.

  Source:
    - AbstractObject.js, line 257

  ##### Returns:

  the description

  Type
    String

#### getId() → {String}

  Hands back the ID ("_doc") of this object.

  Source:
    - AbstractObject.js, line 221

  ##### Returns:

  id

  Type
    String

#### getProxiedUri()

  Hands back the URI of this object as referenced by the browser.

  Source:
    - AbstractObject.js, line 188

#### getSystemMetadata() → {Gitana.SystemMetadata}

  Hands back the system metadata for this object.

  Source:
    - AbstractObject.js, line 233

  ##### Returns:

  system metadata

  Type
    Gitana.SystemMetadata

#### getTitle() → {String}

  The title for the object.

  Source:
    - AbstractObject.js, line 245

  ##### Returns:

  the title

  Type
    String

#### <abstract> getType()

  Source:
    - AbstractObject.js, line 170

#### getUri()

  Source:
    - AbstractObject.js, line 162

#### handleResponse(response)

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `response` |  |

  Inherited From:
    - Gitana.AbstractPersistable#handleResponse
  Source:
    - AbstractPersistable.js, line 36

#### handleSystemProperties()

  Source:
    - AbstractObject.js, line 310

#### json()

  Hands back a cleanup, properties-only JSON simple object.

  Inherited From:
    - Gitana.AbstractPersistable#json
  Source:
    - AbstractPersistable.js, line 66

#### loadFrom(anotherObject)

  Helper method that loads this object from another object of the same type.

  For example, loading a node from another loaded node.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `anotherObject` |  |

  Source:
    - AbstractObject.js, line 342

#### <abstract> ref() → {String}

  Source:
    - AbstractObject.js, line 180

  ##### Returns:

  a string denoting a reference to this object.

  Type
    String

#### replacePropertiesWith(object)

  Replaces all of the properties of this object with those of the given object. This method should be used to update the state of this object.

  Any functions from the incoming object will not be copied.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `object` | Object | object containing the properties

  Source:
    - AbstractObject.js, line 280

#### set(key, value)

  Set a json property

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `key` |  |
  `value` |  |

  Source:
    - AbstractObject.js, line 209

#### stringify(pretty)

  Helper function to convert the object portion to JSON

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `pretty` |  |

  Source:
    - AbstractObject.js, line 330