org.nuxeo.ecm.automation.client.model

Class Document

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, OperationInput

public class Document
extends DocRef

A document. Documents are as they are returned by the server. To modify documents use operations. Use getProperties() method to fetch the document properties and getDirties() to fetch dirty properties updated.

You need to create your own wrapper if you need to access the document properties in a multi-level way. This is a flat representation of the document.

Possible property value types:

• String
• Number
• Date

Author:

Bogdan Stefanescu

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Document(String id, String type) Minimal constructor for automation client Document.
Document(String id, String type, PropertyList facets, String changeToken, String path, String state, String lockOwner, String lockCreated, String repository, PropertyMap properties, PropertyMap contextParameters) Deprecated.
Document(String id, String type, PropertyList facets, String changeToken, String path, String state, String lockOwner, String lockCreated, String repository, String versionLabel, PropertyMap properties, PropertyMap contextParameters) Deprecated.
Document(String id, String type, PropertyList facets, String changeToken, String path, String state, String lockOwner, String lockCreated, String repository, String versionLabel, String isCheckedOut, PropertyMap properties, PropertyMap contextParameters) Reserved to framework.

Method Summary

Methods

Modifier and Type	Method and Description
String	getChangeToken()
PropertyMap	getContextParameters()
Date	getDate(String key)
Date	getDate(String key, Date defValue)
PropertyMap	getDirties() This method fetch the dirty properties of the document (which have been updated during the session)
Double	getDouble(String key)
Double	getDouble(String key, Double defValue)
PropertyList	getFacets()
String	getId()
String	getInputType()
Date	getLastModified()
String	getLock()
String	getLockCreated()
String	getLockOwner()
Long	getLong(String key)
Long	getLong(String key, Long defValue)
String	getPath()
PropertyMap	getProperties()
String	getRepository()
String	getState()
String	getString(String key)
String	getString(String key, String defValue)
String	getTitle()
String	getType()
String	getVersionLabel()
Boolean	isCheckedOut()
boolean	isLocked()
void	set(String key, Boolean defValue)
void	set(String key, Date defValue)
void	set(String key, Double defValue)
void	set(String key, Long defValue)
void	set(String key, PropertyList defValue)
void	set(String key, PropertyMap defValue)
void	set(String key, String defValue)

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

getInputRef, isBinary, newRef, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Document

@Deprecated
public Document(String id,
                   String type,
                   PropertyList facets,
                   String changeToken,
                   String path,
                   String state,
                   String lockOwner,
                   String lockCreated,
                   String repository,
                   PropertyMap properties,
                   PropertyMap contextParameters)

Deprecated.

Document

@Deprecated
public Document(String id,
                   String type,
                   PropertyList facets,
                   String changeToken,
                   String path,
                   String state,
                   String lockOwner,
                   String lockCreated,
                   String repository,
                   String versionLabel,
                   PropertyMap properties,
                   PropertyMap contextParameters)

Deprecated.

Document

public Document(String id,
        String type,
        PropertyList facets,
        String changeToken,
        String path,
        String state,
        String lockOwner,
        String lockCreated,
        String repository,
        String versionLabel,
        String isCheckedOut,
        PropertyMap properties,
        PropertyMap contextParameters)

Reserved to framework. Should be only called by client framework when unmarshalling documents.

Since:

5.7.3

Document

public Document(String id,
        String type)

Minimal constructor for automation client Document. Could be instantiated when creating a document and passing to the related automation operation.

Since:

5.7

Method Detail

getRepository

public String getRepository()

getId

public String getId()

getInputType

public String getInputType()

Specified by:

getInputType in interface OperationInput

Overrides:

getInputType in class DocRef

getPath

public String getPath()

getType

public String getType()

getLock

public String getLock()

getLockOwner

public String getLockOwner()

getLockCreated

public String getLockCreated()

isLocked

public boolean isLocked()

getState

public String getState()

getVersionLabel

public String getVersionLabel()

isCheckedOut

public Boolean isCheckedOut()

getLastModified

public Date getLastModified()

getTitle

public String getTitle()

getProperties

public PropertyMap getProperties()

getString

public String getString(String key)

getDate

public Date getDate(String key)

getLong

public Long getLong(String key)

getDouble

public Double getDouble(String key)

getString

public String getString(String key,
               String defValue)

getDate

public Date getDate(String key,
           Date defValue)

getLong

public Long getLong(String key,
           Long defValue)

getDouble

public Double getDouble(String key,
               Double defValue)

set

public void set(String key,
       String defValue)

set

public void set(String key,
       Date defValue)

set

public void set(String key,
       Long defValue)

set

public void set(String key,
       Double defValue)

set

public void set(String key,
       Boolean defValue)

Since:

5.7

set

public void set(String key,
       PropertyMap defValue)

Since:

5.7

set

public void set(String key,
       PropertyList defValue)

Since:

5.7

getChangeToken

public String getChangeToken()

getFacets

public PropertyList getFacets()

getContextParameters

public PropertyMap getContextParameters()

getDirties

public PropertyMap getDirties()

This method fetch the dirty properties of the document (which have been updated during the session)

Since:

5.7