Class org.omus.data.PropertySet

Implemented Interfaces

iObservable

Description

Groupe de propriétés persistantes correspondant à un client ou un groupe. Celles-ci doivent être définies dans le fichiers config.xml Pour obtenir une référence à ces propriétés, utiliser : Properties of the current group : org.omus.core.Group.getInstance().getProperties() Properties of the currentuser : org.omus.core.User.getInstance().getProperties() Properties of another user in the current group : org.omus.core.Group.getInstance().getUserProperties("username")

Evénements auxquels s'abonner :

Elle est aggrémentée par composition des méthodes des sources d'événements (EventDispatcher).

See Also

Field Index

marsh

Method Index

new PropertySet()
addListener(), contains(), countListeners(), fill(), getChanged(), getMarshalledProperties(), getOwner(), getParent(), getPrimaryKey(), getType(), getValue(), handleIncomingMessage(), handleMessage(), isLoaded(), isModified(), isSynchronized(), isValid(), load(), loadAll(), removeAllListeners(), removeListener(), setValue(), size(), synchronize(), synchronizeFailed(), synchronizeOK(), toLog(), toString(), valueChanged()

Constructor Detail

PropertySet

public function PropertySet(type:String, owner:Object, pKey:Number, par:PropertySet)

L'objet User dispose des méthodes d'EventDispatcher par composition.

Parameters

type"group" ou "user".
ownerUne référence à l'objet propriétaire des propriétés.
pKeyUn identifiant unique au groupe ou utilisateur (clé primaire de la base de données pour grpID et usrID).
parParent éventuel du groupe actuel (cf onSynchronise(PropertySet) et onLoad(PropertySet)).

See Also

Field Detail

marsh

public marsh:MarshalledProperties
TODO

Method Detail

toString

public function toString():String

Utilisé dans un contexte littéral

Return

Une chaine définissant l'objet

getParent

public function getParent():PropertySet

Renvoie le parent. L'objet PropertySet envoyé lors des événements onSynchronise et onLoad correspond à la partie modifiée. Le parent est l'objet complet.

Return

Une référence aux propriétés envoyées partiellement ou null.

getOwner

public function getOwner():Object

Renvoie un identifiant du possesseur des propriétés.

Return

Le nom (string) de l'utilisateur ou une référence à Group.

See Also

getPrimaryKey

public function getPrimaryKey():Number

Renvoie la clé primaire correspondant au possesseur des propriétés.

Return

Un identifiant de la base de données.

size

public function size():Number

Renvoie le nombre de propriétés.

Return

Un nombre total.

getMarshalledProperties

public function getMarshalledProperties():MarshalledProperties

Renvoie une référence aux propiétés encodées.

Return

Une référence.

isSynchronized

public function isSynchronized():Boolean

Renvoie un booléen en fonction de la modification d'une propriété du set, suite à un événément onSynchronise.

Return

true si aucune propriété n'a été modifié.

isValid

public function isValid():Boolean

Permet de savoir si le set de propriétés appartient à un membre du groupe ou au groupe. Une référence à un PropertySet dont le membre aurait quitté le groupe ne sera pas correctement utilisé.

Return

true si PropertySet appartient au groupe ou utilisateur actuel.

getValue

public function getValue(propName:String):Object

Renvoie la valeur d'une propriété specifiée.

Parameters

propNameLe nom d'une propriété.

Return

Une valeur ou null si la propriété n'a pas été chargée.

getType

public function getType(propName:String):String

Renvoie le type d'une d'une propriété spécifiée.

Parameters

propNameLe nom d'une propriété.

Return

type utilisé : …

contains

public function contains(propName:String):Boolean

Permet de savoir si une propriété est contenu dans le set.

Parameters

propNameLe nom d'une propriété.

Return

true si propName appartient au PropertySet.

isModified

public function isModified(propName:String):Boolean

Permet de savoir si une propriété a été modifiée depuis le dernier événement onSynchronise.

Parameters

propNameLe nom de la propriété.

Return

true s'il ya eu modification.

isLoaded

public function isLoaded(propName:String):Boolean

Renseigne si une propriété spécifiée a été chargé dans le poste client.

Parameters

propNameLe nom de la propriété.

Return

true si la valeur d'une propriété est chargée.

setValue

public function setValue(propName:String, newVal:Object):Void

Modifie la valeur d'une propriété sur le poste client dans l'attente de la synchronisation avec le serveur. Le type doit correspondre avec celui contenu dans le fichier config.xml

Parameters

propNameLe nom d'une propriété.
newValUne valeur.

See Also

synchronize

public function synchronize():Void

Synchronise toutes les propriétés d'un set. Le comportement change en fonction de la configuration côté serveur : - Ecriture dans la base de donnée : persistance globale - Synchronisation avec seulement les membres connectés.

load

public function load(propNames:Array):Void

Charge toutes les propriétés spécifiées dans le client.

Parameters

loadAll

public function loadAll():Void

Charge toutes les propriétés non téléchargés automatiquement. Voir config.xml

getChanged

public function getChanged():MarshalledProperties

TODO : Renvoie les propriétés ayant été modifiées ??

Return

Une référence.

valueChanged

public function valueChanged(propName:String, marshVal:Object):Void

TODO : Rajoute la propriété comme étant à soumettre au serveur ??

Parameters

propNameLe nom de la propriété.
marshValNouvelle valeur de la propriété.

fill

public function fill(propConfig:Object, props:Object):Void

Rajoute les propriétés persistantes en les typant correctement avec leur valeurs.

Parameters

propConfigTableau associatif des propriétés.
propsValeurs des propriétés.

See Also

addListener

public function addListener(listener:Object):Boolean

Ajoute un nouvel observateur.

Parameters

listenerRéférence de l'observateur.

Return

Un booléen indiquant la réussite de l'opération.

Specified By

addListener() in org.omus.util.iObservable

removeListener

public function removeListener(listener:Object):Boolean

Supprime un observateur.

Parameters

listenerRéférence de l'observateur.

Return

Un booléen indiquant la réussite de l'opération.

Specified By

removeListener() in org.omus.util.iObservable

removeAllListeners

public function removeAllListeners():Void

Supprime tous les abonnés.

Specified By

removeAllListeners() in org.omus.util.iObservable

countListeners

public function countListeners():Number

Retourne le nombre d'observateurs.

Return

Le nombre d'observateurs enregistrés.

Specified By

countListeners() in org.omus.util.iObservable

handleMessage

public function handleMessage(env:Envelope):Void

Dirige la message d'accusé de réception en fonction du type contenu dans son enveloppe.

Parameters

envEnveloppe du message.

synchronizeOK

public function synchronizeOK(props:Object, cr:Boolean, cache:Object):Void

Gestion de la synchronisation des propriétés suite à une synchronisation serveur. Génère un événement onSynchronise aux observateurs.

Parameters

propsUn objet des propriétés à jour.
crClient request, true si demande émanant du cleint courant.
cacheTODO

synchronizeFailed

public function synchronizeFailed(cache:Object, errCode:String, method:String, args:Array)

Gestion de la synchronisation des propriétés suite à une erreur de synchronisation serveur. Génère un événement onError aux observateurs.

Parameters

cacheUn objet des propriétés à jour.
methodL'accusé de réception d'où émane l'erreur.

toLog

static public function toLog():String

Utilisé dans un contexte littéral

Return

Une chaine définissant l'objet

handleIncomingMessage

static public function handleIncomingMessage(env:Envelope):Void

Gestionnaire d'accusé de réception émanant directement de MessageRouter et chargé de redistribuer les messages entre les propriétés d'un groupe ou d'un utilisateur. TODO : Compileur MMC 2004 n'accepte pas une méthode de classe et d'instance ayant le même nom.

Parameters

envEnveloppe du message.

See Also