new AbstractNode(branch [, object])
Parameters:
Name | Type | Argument | Description |
---|---|---|---|
branch |
Gitana.Branch | ||
object |
Object |
<optional> |
- Source:
Extends
Members
-
getPreviewUri
-
Generates a URI to a preview resource.
- Source:
-
listAttachments
-
Lists the attachments of this node.
If local is set to true, the attachments are drawn from precached values on the node.
- Source:
-
unattach
-
Deletes an attachment.
- Source:
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:
- Source:
-
addFeature(featureId [, Object])
-
Adds a feature to this node.
Parameters:
Name Type Argument Description featureId
String the id of the feature
Object
<optional>
featureConfig the JSON object configuration for the feature
- Source:
-
attach(attachmentId, contentType, data, filename)
-
Creates an attachment.
When using this method from within the browser, it really only works for text-based content such
as JSON or text.Parameters:
Name Type Description attachmentId
(use null or false for default attachment)
contentType
data
filename
- Source:
-
attachment(attachmentId)
-
Picks off a single attachment
Parameters:
Name Type Description attachmentId
(null for default)
- Source:
-
attachmentDownloadUri()
-
Non-chained method for getting a download URI for this node's attachment.
- Source:
-
chainCopyState(otherObject)
-
Override to include:
qname type
features stats
__is_associationParameters:
Name Type Description otherObject
- Overrides:
- Source:
-
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:
- Source:
-
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:
- Source:
-
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
- Inherited From:
- Source:
-
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:
- Source:
-
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:
- Source:
-
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:
- Source:
-
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:
- Source:
-
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:
- Source:
-
chainPatch(chainable, uri, params, payload)
-
Performs a PATCH 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:
- Source:
-
chainPost(chainable, uri, params, payload, handleFn)
-
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
handleFn
- Inherited From:
- Source:
-
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:
- Source:
-
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:
- Source:
-
chainReload(uri, params)
-
Reloads this object from the server and then passes control to the chainable.
Parameters:
Name Type Description uri
params
- Inherited From:
- Source:
-
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
- Inherited From:
- Source:
-
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:
- Source:
-
changeQName(typeQName)
-
Sets the QName of this node.
Parameters:
Name Type Description typeQName
String the qname of the type to change to
- Source:
-
changeTypeQName(typeQName)
-
Changes the type QName for this node.
Parameters:
Name Type Description typeQName
String the qname of the type to change to
- Source:
-
checkAuthority(principal, authorityId, callback)
-
Checks whether the given principal has a granted authority for this object.
This passes the result (true/false) to the chaining function.Parameters:
Name Type Description principal
Gitana.DomainPrincipal | String the principal or the principal id
authorityId
String the id of the authority
callback
- Inherited From:
- Source:
-
checkPermission(principal, permissionId, callback)
-
Checks whether the given principal has a permission against this object.
This passes the result (true/false) to the chaining function.Parameters:
Name Type Description principal
Gitana.DomainPrincipal | String the principal or the principal id
permissionId
String the id of the permission
callback
- Inherited From:
- Source:
-
clone()
-
- Source:
-
copy(target, asynchronous, config)
-
Copies this object into the target.
Parameters:
Name Type Description target
asynchronous
config
- Inherited From:
- Source:
-
del()
-
Delete
- Inherited From:
- Source:
-
exportArchive(settings)
-
Exports an archive.
Parameters:
Name Type Description settings
Object - Inherited From:
- Source:
-
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:
- Source:
-
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:
- Source:
-
get(key)
-
Get a json property
Parameters:
Name Type Description key
- Inherited From:
- Source:
-
getBranch()
-
Gets the Gitana Branch object.
- Source:
Returns:
The Gitana Branch object
- Type
- Gitana.Branch
-
getBranchId()
-
Gets the Gitana Branch id.
- Source:
Returns:
The Gitana Branch id
- Type
- String
-
getDescription()
-
The description for the object.
- Inherited From:
- Source:
Returns:
the description
- Type
- String
-
getFeature(featureId [, Function])
-
Gets the configuration for a given feature.
Parameters:
Name Type Argument Description featureId
String the id of the feature
Function
<optional>
callback optional callback
- Source:
Returns:
the JSON object configuration for the feature
- Type
- Object
-
getFeatureIds( [Function])
-
Hands back a list of the feature ids that this node has.
Parameters:
Name Type Argument Description Function
<optional>
callback optional callback
- Source:
Returns:
An array of strings that are the ids of the features.
- Type
- Array
-
getId()
-
Hands back the ID ("_doc") of this object.
- Inherited From:
- Source:
Returns:
id
- Type
- String
-
getProxiedUri()
-
Hands back the URI of this object as referenced by the browser.
- Inherited From:
- Source:
-
getQName()
-
Gets the QName for this node.
- Source:
Returns:
the qname of this node.
- Type
- String
-
getRepository()
-
Gets the Gitana Repository object.
- Inherited From:
- Source:
Returns:
The Gitana Repository object
- Type
- Gitana.Repository
-
getRepositoryId()
-
Gets the Gitana Repository id.
- Inherited From:
- Source:
Returns:
The Gitana Repository id
- Type
- String
-
getSystemMetadata()
-
Hands back the system metadata for this object.
- Inherited From:
- Source:
Returns:
system metadata
-
getTitle()
-
The title for the object.
- Inherited From:
- Source:
Returns:
the title
- Type
- String
-
<abstract> getType()
-
- Inherited From:
- Source:
-
getTypeQName()
-
Gets the type QName for this node.
- Source:
Returns:
the type qname of this node.
- Type
- String
-
getUri()
-
- Inherited From:
- Overrides:
- Source:
-
grantAuthority(principal, authorityId)
-
Grants an authority to a principal against this object.
Parameters:
Name Type Description principal
Gitana.DomainPrincipal | String the principal or the principal id
authorityId
String the id of the authority
- Inherited From:
- Source:
-
handleResponse(response)
-
Parameters:
Name Type Description response
- Inherited From:
- Source:
-
handleSystemProperties()
-
Gets called after the response is handled and allows the object to pull out special values from
the "object" field so that they don't sit on the JSON object- Inherited From:
- Overrides:
- Source:
-
hasFeature(featureId [, Function])
-
Indicates whether this node has the given feature.
Parameters:
Name Type Argument Description featureId
String the id of the feature
Function
<optional>
callback optional callback to receive result (for chaining)
- Source:
Returns:
whether this node has this feature
- Type
- Boolean
-
importArchive(settings [, Function])
-
Imports an archive.
Parameters:
Name Type Argument Description settings
Object Function
<optional>
reportFn
- Inherited From:
- Source:
-
isAssociation()
-
Indicates whether the current object is an association.
- Source:
Returns:
whether this node is an association
- Type
- Boolean
-
isContainer()
-
Indicates whether this node has the "f:container" feature
- Source:
Returns:
whether this node has the "f:container" feature
- Type
- Boolean
-
json()
-
Hands back a cleanup, properties-only JSON simple object.
- Inherited From:
- Source:
-
listAuthorities(principal, callback)
-
Retrieve list of authorities and pass into chaining method.
Parameters:
Name Type Description principal
Gitana.DomainPrincipal | String the principal or the principal id
callback
- Inherited From:
- Source:
-
loadACL(callback)
-
Retrieve full ACL and pass into chaining method.
Parameters:
Name Type Description callback
- Inherited From:
- Source:
-
loadAuthorityGrants(callback)
-
Loads the authority grants for a given set of principals.
Parameters:
Name Type Description callback
- Inherited From:
- Source:
-
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
- Inherited From:
- Source:
-
ref()
-
- Inherited From:
- Overrides:
- Source:
Returns:
a string denoting a reference to this object.
- Type
- String
-
refresh()
-
Refreshes the node. This allows the node to reindex and regenerate any renditions it may
have associated with it.- Source:
-
reload()
-
Reload
- Inherited From:
- Source:
-
removeFeature(featureId)
-
Removes a feature from this node.
Parameters:
Name Type Description featureId
String the id of the feature
- Source:
-
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
- Inherited From:
- Source:
-
revokeAllAuthorities(principal)
-
Revokes all authorities for a principal against the server.
Parameters:
Name Type Description principal
Gitana.Principal | String the principal or the principal id
- Inherited From:
- Source:
-
revokeAuthority(principal, authorityId)
-
Revokes an authority from a principal against this object.
Parameters:
Name Type Description principal
Gitana.DomainPrincipal | String the principal or the principal id
authorityId
String the id of the authority
- Inherited From:
- Source:
-
set(key, value)
-
Set a json property
Parameters:
Name Type Description key
value
- Inherited From:
- Source:
-
stats()
-
Hands back the stats.
- Source:
-
stringify(pretty)
-
Helper function to convert the object portion to JSON
Parameters:
Name Type Description pretty
- Inherited From:
- Source:
-
touch()
-
Touches the node.
- Source:
-
update()
-
Update
- Inherited From:
- Source: