Class: $ressourceRemote

$ressourceRemote()

new $ressourceRemote()

Service d'accès aux ressources d'autres sesatheques

Source:
Requires:
  • module:$ressourceRepository

Requires

  • module:$ressourceRepository

Methods

(static) externalUpdate(baseId, ref, next)

Demande une mise à jour des arbres distants en envoyant une ref qui a changé ici

Parameters:
Name Type Description
baseId string
ref Ref
next simpleCallback
Source:

(static) archive(ressource, next)

Enregistre la ressource en archive et appelle next avec, mais ne modifie pas la ressource

Parameters:
Name Type Description
ressource EntityRessource
next

appelé avec (error, archive)
Source:

(static) load(oid, next) → {undefined}

Récupère une ressource et la passe à next (ressource undefined si elle n’existe pas)

Parameters:
Name Type Description
oid number | String

L'identifiant de la ressource (on accepte oid ou string origine/idOrigine)
next ressourceCallback

appelée avec une EntityRessource
Source:
Returns:
Type
undefined

(static) loadByAliasAndPid(aliasOf, rid, next)

Récupère une ressource d'un auteur d'après son aliasOf (pour voir si cette personne
a déjà un alias qui pointe sur aliasOf)

Parameters:
Name Type Description
aliasOf string
rid string
next ressourcesCallback

appelée avec une EntityRessource
Source:

(static) loadByCle(cle, next)

Récupère une ressource d'après sa cle et la passe à next

Parameters:
Name Type Description
cle string
next ressourceCallback

appelée avec une EntityRessource
Source:

(static) loadByOrigin(origine, idOrigine, next)

Récupère une ressource d'après son idOrigine (ou son rid, dans ce cas origine est notre baseId) et la passe à next

Parameters:
Name Type Description
origine string

(ou "cle" avec idOrigine qui est la clé, ou la baseId courante avec idOrigine qui est l'oid)
idOrigine string
next ressourceCallback

appelée avec une EntityRessource
Source:

(static) remove(ressource, next) → {undefined}

Efface une ressource (et ses index)

Parameters:
Name Type Description
ressource EntityRessource | string

(ou son oid)
next errorCallback
Source:
Returns:
Type
undefined

(static) save(ressource, nextopt)

Ajoute ou modifie une ressource (contrôle la validité avant et incrémente la version au besoin),
met à jour le cache (interne + varnish) et toutes les relations (passe en revue tous les éventuels
arbres qui référencent cette ressource)

ATTENTION, c'est la seule méthode qui garanti l'intégrité du cache, entityRessource.store()
utilisé directement peut être plus efficace pour du batch, mais faut y réfléchir à deux fois !

Parameters:
Name Type Attributes Description
ressource EntityRessource
next ressourceCallback <optional>

appelée avec une EntityRessource
Source:

(static) search(searchQuery, queryOptions, next)

Récupère un liste de ressource d'après critères

Parameters:
Name Type Description
searchQuery searchQuery

Les critères de tri
queryOptions searchQueryOptions

Les options (skip & limit + orderBy éventuel)
next ressourcesCallback

appelée avec (error, {ressources, total})
Source:

(inner) checkRegisterListener(ressource, ressourceBdd)

Enregistre ou supprime des listeners pour nos enfants externes s'ils ont changé

Parameters:
Name Type Description
ressource Ressource
ressourceBdd Ressource
Source:

(inner) convertXmlEc2(ressource)

Converti un xml qui trainerait en parametres en json pour les ec2

Parameters:
Name Type Description
ressource
Source:

(inner) convertXmlJ3p(ressource)

Modifie les parametres de ressource pour remplacer un éventuel xml par un graphe

Parameters:
Name Type Description
ressource Ressource
Source:

(inner) getDeferred(token, next)

Récupère oid et user d'après le token

Parameters:
Name Type Description
token
next
Source:

(inner) grabSearch(searchQuery, queryOptions, next)

Récupère un liste de ressource d'après critères

Parameters:
Name Type Description
searchQuery searchQuery

Les critères de tri
queryOptions searchQueryOptions

Les options (skip & limit + orderBy éventuel)
next ressourcesCallback

appelée avec (error, ressources)
Source:

(inner) grabSearchCount(searchQuery, next)

Compte le nb de ressources d'après les critères de recherche

Parameters:
Name Type Description
searchQuery searchQuery

Les critères de tri
next function

appelée avec (error, total)
Source:

(inner) purgeVarnish(ressource)

Purge les urls publiques de la ressource sur varnish (si varnish est dans la conf, ne fait rien sinon)
(rend la main avant les réponses mais après avoir lancé les requêtes)

Parameters:
Name Type Description
ressource Ressource | string

ou son oid
Source:

(inner) register(rids, next)

Enregistre un listener pour être prévenu (call sur updateArbre)

Parameters:
Name Type Description
rids Array.<string>

liste de rid (qui doivent tous être sur la même baseId)
next
Source:

(inner) registerCall(action, rids, next)

Appelle registerListener pour ajouter ou virer des listener

Parameters:
Name Type Description
action string

add|delete
rids Array.<string>

liste de rid (qui doivent tous être sur la même baseId)
next
Source:

(inner) removeGroup(nom, next)

Supprime un groupe de toutes les ressources qui le contiennent (groupes et groupesAuteurs)

Parameters:
Name Type Description
nom string
next errorCallback
Source:

(inner) renameGroup(oldName, newName, next)

Renomme un groupe chez toutes les ressources qui l'ont (dans groupes ou groupesAuteurs)

Parameters:
Name Type Description
oldName
newName
next
Source:

(inner) saveDeferred(oid, next)

Met en cache la ressource et le user pour modification ultérieure

Parameters:
Name Type Description
oid number
next function
Source:

(inner) unregister(rids, next)

Supprime un listener

Parameters:
Name Type Description
rids Array.<string>

liste de rid (qui doivent tous être sur la même baseId)
next
Source:

(inner) updateParent(ref, next)

Met à jour les arbres ou séries stockés ici qui ont ref comme enfant

Parameters:
Name Type Description
ref Ref
next function

appelée avec (error, nbArbres)
Source:

Type Definitions

getListeFilter

Filtre de la forme {index:'indexAFiltrer', values:valeurs},
valeurs peut être un tableau de valeurs ou [undefined] (ça filtrera sur les ressources ayant cet index)

Type:
  • Object
Source:

getListeFilters

Tableau de filtres

Type:
Source:

ressourcesCallback(error, ressources)

Parameters:
Name Type Description
error Error
ressources Array.<Ressource>
Source: