org.nuxeo.ecm.automation.client.model

Class NuxeoDocument

java.lang.Object

org.nuxeo.ecm.automation.client.model.DocRef

org.nuxeo.ecm.automation.client.model.Document

org.nuxeo.ecm.automation.client.model.NuxeoDocument

All Implemented Interfaces:

Serializable, OperationInput, org.osivia.portal.api.cms.EcmDocument

public final class NuxeoDocument
extends Document

Version corrigée de Document.

Les corrections sont les suivantes :

• Des constructeurs plus simples ont été ajoutés.
• Les variables d'instance de type PropertyMap utilisent NuxeoPropertyMap.
• La méthode remove(String) a été ajoutée (car set("name", null) ne supprime pas la propriété "name", mais lui associe null).
• Des méthodes equals(Object) et hashCode() ont été définies qui prennent en compte l'état de l'objet.

Author:

Kévin Le Helley

See Also:

Document, Serialized Form

Field Summary

Fields inherited from class org.nuxeo.ecm.automation.client.model.Document

changeToken, contextParameters, facets, lockCreated, lockOwner, path, properties, repository, state, type, versionLabel

Fields inherited from class org.nuxeo.ecm.automation.client.model.DocRef

ref

Constructor Summary

Constructors

Constructor and Description
NuxeoDocument(String type) Constructeur simple.
NuxeoDocument(String type, String id, String path, String state) Constructeur.
NuxeoDocument(String type, String id, String path, String state, PropertyMap properties) Constructeur.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getBoolean(String key) Fournit la valeur d'une propriété.
Boolean	getBoolean(String key, Boolean defValue) Fournit la valeur d'une propriété, ou retourne la valeur par défaut fournie.
PropertyList	getList(String key) Fournit la valeur d'une propriété.
PropertyList	getList(String key, PropertyList defValue) Fournit la valeur d'une propriété, ou retourne la valeur par défaut fournie.
PropertyMap	getMap(String key) Fournit la valeur d'une propriété.
PropertyMap	getMap(String key, PropertyMap defValue) Fournit la valeur d'une propriété, ou retourne la valeur par défaut fournie.
int	hashCode()
void	remove(String key) Supprime une propriété.
void	set(String key, Boolean value) Ajoute ou modifie une propriété.
void	set(String key, PropertyList value) Ajoute ou modifie une propriété.
void	set(String key, PropertyMap value) Ajoute ou modifie une propriété.

Methods inherited from class org.nuxeo.ecm.automation.client.model.Document

getChangeToken, getContextParameters, getDate, getDate, getDouble, getDouble, getFacets, getId, getInputType, getLastModified, getLock, getLockCreated, getLockOwner, getLong, getLong, getPath, getProperties, getRepository, getState, getString, getString, getTitle, getType, getVersionLabel, isLocked, set, set, set, set

Methods inherited from class org.nuxeo.ecm.automation.client.model.DocRef

getInputRef, isBinary, newRef, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NuxeoDocument

public NuxeoDocument(String type)

Constructeur simple.

Parameters:

type - le type du document

NuxeoDocument

public NuxeoDocument(String type,
             String id,
             String path,
             String state)

Constructeur.

Parameters:

type - le type du document

id - l'identifiant du document

path - le chemin du document

state - l'état du document

NuxeoDocument

public NuxeoDocument(String type,
             String id,
             String path,
             String state,
             PropertyMap properties)

Constructeur.

Parameters:

type - le type du document

id - l'identifiant du document

path - le chemin du document

state - l'état du document

properties - les propriétés du document

Method Detail

getBoolean

public Boolean getBoolean(String key)

Fournit la valeur d'une propriété.

Parameters:

key - le nom de la propriété

Returns:

la valeur associée si elle existe ; null si la propriété n'existe pas ou qu'elle ne contient rien

getMap

public PropertyMap getMap(String key)

Fournit la valeur d'une propriété.

Parameters:

key - le nom de la propriété

Returns:

la valeur associée si elle existe ; null si la propriété n'existe pas ou qu'elle ne contient rien

getList

public PropertyList getList(String key)

Fournit la valeur d'une propriété.

Parameters:

key - le nom de la propriété

Returns:

la valeur associée si elle existe ; null si la propriété n'existe pas ou qu'elle ne contient rien

getBoolean

public Boolean getBoolean(String key,
                 Boolean defValue)

Fournit la valeur d'une propriété, ou retourne la valeur par défaut fournie.

Parameters:

key - le nom de la propriété

defValue - la valeur retournée par défaut

Returns:

la valeur associée si elle existe, sinon la valeur par défaut spécifiée

getMap

public PropertyMap getMap(String key,
                 PropertyMap defValue)

Fournit la valeur d'une propriété, ou retourne la valeur par défaut fournie.

Parameters:

key - le nom de la propriété

defValue - la valeur retournée par défaut

Returns:

la valeur associée si elle existe, sinon la valeur par défaut spécifiée

getList

public PropertyList getList(String key,
                   PropertyList defValue)

Fournit la valeur d'une propriété, ou retourne la valeur par défaut fournie.

Parameters:

key - le nom de la propriété

defValue - la valeur retournée par défaut

Returns:

la valeur associée si elle existe, sinon la valeur par défaut spécifiée

set

public void set(String key,
       Boolean value)

Ajoute ou modifie une propriété.

Parameters:

key - le nom de la propriété

value - la valeur à lui associer

set

public void set(String key,
       PropertyMap value)

Ajoute ou modifie une propriété.

Parameters:

key - le nom de la propriété

value - la valeur à lui associer

set

public void set(String key,
       PropertyList value)

Ajoute ou modifie une propriété.

Parameters:

key - le nom de la propriété

value - la valeur à lui associer

remove

public void remove(String key)

Supprime une propriété.

Parameters:

key - le nom de la propriété

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object