org.nuxeo.client.objects

Class Document

java.lang.Object

org.nuxeo.client.objects.AbstractBase<B>

org.nuxeo.client.objects.AbstractConnectable<A,B>

org.nuxeo.client.objects.ConnectableEntity<A,B>

org.nuxeo.client.objects.RepositoryEntity<RepositoryAPI,Document>

org.nuxeo.client.objects.Document

All Implemented Interfaces:

Connectable

public class Document
extends RepositoryEntity<RepositoryAPI,Document>

Since:

0.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.AbstractAdapter<A extends Document.AbstractAdapter<A>> Adapter is basic class to handle requests against web adapters.
static class	Document.Adapter Adapter is basic class to handle requests against web adapters.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	changeToken
protected Map<String,Object>	contextParameters
static String	DEFAULT_FILE_CONTENT
protected static String	DELETED_STATE
protected Map<String,Object>	dirtyProperties
protected List<String>	facets
protected String	isCheckedOut
protected boolean	isProxy
protected Boolean	isTrashed
protected String	lastModified
protected String	lockCreated
protected String	lockOwner
protected String	name
protected String	parentRef
protected String	path
protected Map<String,Object>	properties
protected String	state
protected String	title
protected String	type
protected String	uid
protected String	versionLabel

Fields inherited from class org.nuxeo.client.objects.RepositoryEntity

repositoryName

Fields inherited from class org.nuxeo.client.objects.ConnectableEntity

entityType

Fields inherited from class org.nuxeo.client.objects.AbstractConnectable

api, apiClass, nuxeoClient

Fields inherited from class org.nuxeo.client.objects.AbstractBase

headerInterceptors, headerValues, okhttpBuilder, retrofit, retrofitBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Document() For internal marshalling purpose.
protected	Document(Document document) This constructor is providing a way to create 'adapters' of a document.
protected	Document(String uid, String type) Protected constructor for adapters implementation.

Method Summary

Modifier and Type	Method and Description
<A extends Document.AbstractAdapter> A	adapter(Function<Document,A> creator) Gets an adapter object to build requests against Nuxeo Server Web Adapter.
Document.Adapter	adapter(String adapter) Gets an adapter object to build requests against Nuxeo Server Web Adapter.
Document	addInvitation(ACE ace, String email) Add permission on the current document by passing the related email.
void	addInvitation(ACE ace, String email, retrofit2.Callback<Document> callback) Add permission on the current document by passing the related email.
Document	addPermission(ACE ace) Add permission on the current document.
void	addPermission(ACE ace, retrofit2.Callback<Document> callback) Add permission on the current document.
static Document	createWithId(String uid, String type) Regular way to instantiate a Document in order to update it.
static Document	createWithName(String name, String type) Regular way to instantiate a Document in order to create it.
Audit	fetchAudit()
void	fetchAudit(retrofit2.Callback<Audit> callback)
FileBlob	fetchBlob() Deprecated. since 3.1, use streamBlob() instead
void	fetchBlob(retrofit2.Callback<FileBlob> callback) Deprecated. since 3.1, use streamBlob(Callback) instead
FileBlob	fetchBlob(String fieldPath) Deprecated. since 3.1, use streamBlob(String) instead
void	fetchBlob(String fieldPath, retrofit2.Callback<FileBlob> callback) Deprecated. since 3.1, use streamBlob(String, Callback) instead
Documents	fetchChildren()
void	fetchChildren(retrofit2.Callback<Documents> callback)
ACP	fetchPermissions()
void	fetchPermissions(retrofit2.Callback<ACP> callback)
Task	fetchTask() Deprecated. since 3.2, this method has never worked, use fetchTasks() instead
Tasks	fetchTasks()
Workflows	fetchWorkflowInstances()
void	fetchWorkflowInstances(retrofit2.Callback<Workflows> callback)
String	getChangeToken()
<T> T	getContextParameter(String key)
Map<String,Object>	getContextParameters()
Map<String,Object>	getDirtyProperties() Get the dirty properties.
List<String>	getFacets()
String	getId()
String	getIsCheckedOut()
String	getLastModified()
String	getLock()
String	getLockCreated()
String	getLockOwner()
String	getName()
String	getParentRef()
String	getPath()
Map<String,Object>	getProperties()
<T> T	getPropertyValue(String key)
String	getState()
String	getTitle()
String	getType()
String	getUid()
String	getVersionLabel()
Boolean	isCheckedOut()
boolean	isLocked()
boolean	isProxy() CAUTION: Only available for Nuxeo Server greater than LTS 2016 - 8.10
boolean	isTrashed()
void	reconnectWith(NuxeoClient nuxeoClient)
void	removePermission(String username) Remove all permissions for a given username on the current document.
void	removePermission(String aceId, String username, String aclName) Remove all permissions for a given username, ace id, acl name on the current document.
void	setContextParameters(Map<String,Object> contextParameters)
void	setDirtyProperties(Map<String,Object> dirtyProperties)
void	setProperties(Map<String,Object> properties) Sets several properties in one call, this method will also put input properties to dirty properties.
void	setPropertyValue(String key, Object value) Sets one property value, property's value will also be put to dirty properties.
Workflow	startWorkflowInstance(Workflow workflow)
void	startWorkflowInstance(Workflow workflow, retrofit2.Callback<Workflow> callback)
StreamBlob	streamBlob()
void	streamBlob(retrofit2.Callback<StreamBlob> callback)
StreamBlob	streamBlob(String fieldPath)
void	streamBlob(String fieldPath, retrofit2.Callback<StreamBlob> callback)
protected Map<String,Object>	toAutomationParameters(ACE ace)
Document	trash() This API is available since Nuxeo Server 10.2.
Document	untrash() This API is available since Nuxeo Server 10.2.
Document	updateDocument()

Methods inherited from class org.nuxeo.client.objects.RepositoryEntity

getRepositoryName

Methods inherited from class org.nuxeo.client.objects.ConnectableEntity

getEntityType

Methods inherited from class org.nuxeo.client.objects.AbstractConnectable

buildRetrofit, fetchResponse, fetchResponse

Methods inherited from class org.nuxeo.client.objects.AbstractBase

connectTimeout, depth, enrichers, enrichers, enrichersForDocument, fetchProperties, fetchProperties, fetchPropertiesForDocument, fetchPropertiesForGroup, header, header, header, header, header, header, header, readTimeout, replaceWith, schemas, schemas, timeout, transactionTimeout, version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_FILE_CONTENT

public static final String DEFAULT_FILE_CONTENT

See Also:

Constant Field Values

DELETED_STATE

protected static final String DELETED_STATE

See Also:

Constant Field Values

path

protected String path

type

protected String type

state

protected String state

lockOwner

protected String lockOwner

lockCreated

protected String lockCreated

versionLabel

protected String versionLabel

isCheckedOut

protected String isCheckedOut

lastModified

protected String lastModified

properties

protected Map<String,Object> properties

dirtyProperties

protected Map<String,Object> dirtyProperties

contextParameters

protected Map<String,Object> contextParameters

changeToken

protected String changeToken

facets

protected List<String> facets

parentRef

protected String parentRef

uid

protected String uid

title

protected String title

name

protected String name

isProxy

protected boolean isProxy

Since:

2.3

isTrashed

protected Boolean isTrashed

Constructor Detail

Document

protected Document()

For internal marshalling purpose.

Document

protected Document(String uid,
                   String type)

Protected constructor for adapters implementation.

Since:

3.0 this constructor has changed its meaning, it is used for adapters, see org.nuxeo.client.objects.DataSet.

Document

protected Document(Document document)

This constructor is providing a way to create 'adapters' of a document. See org.nuxeo.client.objects.DataSet in nuxeo-java-client-test.

Parameters:

document - the document to copy from the sub class.

Since:

1.0

Method Detail

createWithId

public static Document createWithId(String uid,
                                    String type)

Regular way to instantiate a Document in order to update it.

Since:

3.0

createWithName

public static Document createWithName(String name,
                                      String type)

Regular way to instantiate a Document in order to create it.

Since:

3.0

getId

public String getId()

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()

getTitle

public String getTitle()

getChangeToken

public String getChangeToken()

getFacets

public List<String> getFacets()

getIsCheckedOut

public String getIsCheckedOut()

getParentRef

public String getParentRef()

getUid

public String getUid()

getLastModified

public String getLastModified()

getName

public String getName()

getProperties

public Map<String,Object> getProperties()

getPropertyValue

public <T> T getPropertyValue(String key)

setPropertyValue

public void setPropertyValue(String key,
                             Object value)

Sets one property value, property's value will also be put to dirty properties.

setProperties

public void setProperties(Map<String,Object> properties)

Sets several properties in one call, this method will also put input properties to dirty properties.

setDirtyProperties

public void setDirtyProperties(Map<String,Object> dirtyProperties)

setContextParameters

public void setContextParameters(Map<String,Object> contextParameters)

getDirtyProperties

public Map<String,Object> getDirtyProperties()

Get the dirty properties.

getContextParameter

public <T> T getContextParameter(String key)

Returns:

The value associates to the input key from the context parameters.

Since:

3.0

getContextParameters

public Map<String,Object> getContextParameters()

updateDocument

public Document updateDocument()

fetchAudit

public Audit fetchAudit()

fetchAudit

public void fetchAudit(retrofit2.Callback<Audit> callback)

fetchPermissions

public ACP fetchPermissions()

addPermission

public Document addPermission(ACE ace)

Add permission on the current document.

Parameters:

ace - the permission.

Since:

1.0

toAutomationParameters

protected Map<String,Object> toAutomationParameters(ACE ace)

addInvitation

public Document addInvitation(ACE ace,
                              String email)

Add permission on the current document by passing the related email.

Parameters:

ace - the permission.

email - the invited email.

Since:

1.0

removePermission

public void removePermission(String username)

Remove all permissions for a given username on the current document.

Parameters:

username - User Name.

Since:

1.0

removePermission

public void removePermission(String aceId,
                             String username,
                             String aclName)

Remove all permissions for a given username, ace id, acl name on the current document.

Parameters:

aceId - ACE ID.

username - User Name.

aclName - Name of the ACL (local, inherited...).

Since:

1.0

fetchPermissions

public void fetchPermissions(retrofit2.Callback<ACP> callback)

addPermission

public void addPermission(ACE ace,
                          retrofit2.Callback<Document> callback)

Add permission on the current document.

Parameters:

ace - the permission.

Since:

1.0

addInvitation

public void addInvitation(ACE ace,
                          String email,
                          retrofit2.Callback<Document> callback)

Add permission on the current document by passing the related email.

Parameters:

ace - the permission.

email - the invited email.

Since:

1.0

fetchChildren

public Documents fetchChildren()

fetchChildren

public void fetchChildren(retrofit2.Callback<Documents> callback)

fetchBlob

@Deprecated
public FileBlob fetchBlob()

Deprecated. since 3.1, use streamBlob() instead

fetchBlob

@Deprecated
public FileBlob fetchBlob(String fieldPath)

Deprecated. since 3.1, use streamBlob(String) instead

streamBlob

public StreamBlob streamBlob()

streamBlob

public StreamBlob streamBlob(String fieldPath)

fetchBlob

@Deprecated
public void fetchBlob(retrofit2.Callback<FileBlob> callback)

Deprecated. since 3.1, use streamBlob(Callback) instead

fetchBlob

@Deprecated
public void fetchBlob(String fieldPath,
                                  retrofit2.Callback<FileBlob> callback)

Deprecated. since 3.1, use streamBlob(String, Callback) instead

streamBlob

public void streamBlob(retrofit2.Callback<StreamBlob> callback)

streamBlob

public void streamBlob(String fieldPath,
                       retrofit2.Callback<StreamBlob> callback)

fetchWorkflowInstances

public Workflows fetchWorkflowInstances()

startWorkflowInstance

public Workflow startWorkflowInstance(Workflow workflow)

fetchWorkflowInstances

public void fetchWorkflowInstances(retrofit2.Callback<Workflows> callback)

startWorkflowInstance

public void startWorkflowInstance(Workflow workflow,
                                  retrofit2.Callback<Workflow> callback)

fetchTask

@Deprecated
public Task fetchTask()

Deprecated. since 3.2, this method has never worked, use fetchTasks() instead

fetchTasks

public Tasks fetchTasks()

isProxy

public boolean isProxy()

CAUTION: Only available for Nuxeo Server greater than LTS 2016 - 8.10

Since:

2.3

isTrashed

public boolean isTrashed()

Since:

3.1

trash

public Document trash()

This API is available since Nuxeo Server 10.2.

Since:

3.1

untrash

public Document untrash()

This API is available since Nuxeo Server 10.2.

Since:

3.1

adapter

public Document.Adapter adapter(String adapter)

Gets an adapter object to build requests against Nuxeo Server Web Adapter.

Parameters:

adapter - the adapter to hit

Since:

3.2

adapter

public <A extends Document.AbstractAdapter> A adapter(Function<Document,A> creator)

Gets an adapter object to build requests against Nuxeo Server Web Adapter.

Parameters:

creator - the function used to instantiate a specific adapter

Since:

3.2

reconnectWith

public void reconnectWith(NuxeoClient nuxeoClient)

Specified by:

reconnectWith in interface Connectable

Overrides:

reconnectWith in class AbstractConnectable<RepositoryAPI,Document>