Global - Documentation

Members

(constant) updateOrCreateResource :_updateOrCreateResource

Source:

factory.js, line 279

Type:

_updateOrCreateResource

Methods

buildQuery(struct, isAnd) → {string}

Source:

SolrQuery.js, line 51

Parameters:

Name	Type	Description
`struct`
`isAnd`

Returns:

Type: string

createSearchList(entryStore, query) → {SearchList}

Source:

factory.js, line 299

Parameters:

Name	Type	Description
`entryStore`
`query`

Returns:

Type: SearchList

extractSearchResults(data, list, entryStore) → {Array.<Entry>}

Source:

factory.js, line 308

Parameters:

Name	Type	Description
`data`
`list`
`entryStore`

Returns:

Type: Array.<Entry>

fixNameAndDisabled(resObj, data)

Source:

factory.js, line 72

Parameters:

Name	Type	Description
`resObj`
`data`

getCachedExternalMetadataURI(entryURI) → {string}

Source:

factory.js, line 326

Parameters:

Name	Type	Description
`entryURI`

Returns:

Type: string

getContext(entryStore, contextEntryURI) → {Context}

Source:

factory.js, line 214

Parameters:

Name	Type	Description
`entryStore`
`contextEntryURI`

Returns:

Type: Context

getContextForEntry(entryURI, entryStore) → {*}

Source:

factory.js, line 40

Parameters:

Name	Type	Description
`entryURI`
`entryStore`

Returns:

Type: *

getContextId(uri, base) → {string|undefined}

Source:

factory.js, line 361

Parameters:

Name	Type	Description
`uri`
`base`

Returns:

Type: string | undefined

getDefaultLimit() → {number}

Source:

factory.js, line 599

Returns:

Type: number

getEntryCreatePostData(prototypeEntry) → {string}

Source:

factory.js, line 520

Parameters:

Name	Type	Description
`prototypeEntry`

Returns:

Type: string

getEntryCreateURI(prototypeEntry, parentListEntry) → {string}

Source:

factory.js, line 482

Parameters:

Name	Type	Description
`prototypeEntry`
`parentListEntry`

Returns:

Type: string

getEntryId(uri, base) → {string|undefined}

Source:

factory.js, line 339

Parameters:

Name	Type	Description
`uri`
`base`

Returns:

Type: string | undefined

getEntryLoadURI(entryURI, params) → {string}

Source:

factory.js, line 454

Parameters:

Name	Type	Description
`entryURI`
`params`

Returns:

Type: string

getEntryURI(entryStore, contextId, entryId) → {string}

Source:

factory.js, line 393

Parameters:

Name	Type	Description
`entryStore`
`contextId`
`entryId`

Returns:

Type: string

getEntryURIFromURI(entryStore, uri) → {string}

Source:

factory.js, line 381

Parameters:

Name	Type	Description
`entryStore`
`uri`

Returns:

Type: string

getId()

Source:

factory.js, line 331

Deprecated:

in favor of factory#getEntryId

getList(entryStore, entryURI) → {List}

Source:

factory.js, line 233

Parameters:

Name	Type	Description
`entryStore`
`entryURI`

Returns:

Type: List

getMetadataURI(entryStore, contextId, entryId) → {string}

Source:

factory.js, line 413

Parameters:

Name	Type	Description
`entryStore`
`contextId`
`entryId`

Returns:

Type: string

getMetadataURIFromURI(entryStore, uri) → {string}

Source:

factory.js, line 401

Parameters:

Name	Type	Description
`entryStore`
`uri`

Returns:

Type: string

getMoveURI(entry, fromListEntry, toListEntry, baseURI) → {string}

Source:

factory.js, line 554

Parameters:

Name	Type	Description
`entry`
`fromListEntry`
`toListEntry`
`baseURI`

Returns:

Type: string

getPreventCacheNumber() → {number}

Source:

Rest.js, line 30

Returns:

Type: number

getProxyURI(baseURI, uri, formatHint) → {string}

Source:

factory.js, line 567

Parameters:

Name	Type	Description
`baseURI`
`uri`
`formatHint`

Returns:

Type: string

getPutFileURI(uri) → {string}

Source:

factory.js, line 580

Parameters:

Name	Type	Description
`uri`

Returns:

Type: string

getResourceBase(entryStore, contextId) → {string}

Source:

factory.js, line 422

Parameters:

Name	Type	Description
`entryStore`
`contextId`

Returns:

Type: string

getResourceTypeHelper(entry, vocab) → {*}

Source:

EntryInfo.js, line 12

Parameters:

Name	Type	Description
`entry`
`vocab`

Returns:

Type: *

getResourceURI(entryStore, contextId, entryId) → {string}

Source:

factory.js, line 432

Parameters:

Name	Type	Description
`entryStore`
`contextId`
`entryId`

Returns:

Type: string

getSort() → {Object}

Source:

factory.js, line 593

Returns:

Type: Object

getURIFromCreated(data, context) → {string}

Source:

factory.js, line 445

Parameters:

Name	Type	Description
`data`
`context`

Returns:

Type: string

sameOrigin(url) → {boolean}

Source:

Rest.js, line 15

Check if requests will be to the same domain, i.e. no CORS. Must be used in a browser environment.

Parameters:

Name	Type	Description
`url`

Returns:

Type: boolean

setDefaultLimit(limit)

Source:

factory.js, line 605

Parameters:

Name	Type	Description
`limit`

setSort(sortObject)

Source:

factory.js, line 586

Parameters:

Name	Type	Description
`sortObject`

solrFriendly(key, term, isFacet) → {*}

Source:

SolrQuery.js, line 28

Empty spaces in search term should be interpreted as AND instead of the default OR. In addition, fields indexed as text_ngram will have to be shortened to the ngram max limit as they will not match otherwise.

Parameters:

Name	Type	Description
`key`
`term`
`isFacet`

Returns:

Type: *

transformRights(rights)

Source:

factory.js, line 58

Parameters:

Name	Type	Description
`rights`

update(entry, data)

Source:

factory.js, line 286

Parameters:

Name	Type	Description
`entry`	Entry
`data`	Object

updateOrCreate(entryURI, data, entryStore) → {Entry}

Source:

factory.js, line 258

Parameters:

Name	Type	Description
`entryURI`
`data`
`entryStore`

Returns:

Type: Entry