org.nuxeo.ecm.automation.client.adapters

Class DocumentService

java.lang.Object

org.nuxeo.ecm.automation.client.adapters.DocumentService

public class DocumentService
extends Object

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
static String	CheckIn
static String	CheckOut
static String	CopyDocument
static String	CreateDocument
static String	CreateRelation
static String	CreateVersion
static String	DeleteDocument
static String	FetchDocument
static String	FireEvent
static String	GetBlob
static String	GetBlobs
static String	GetDocumentChild
static String	GetDocumentChildren
static String	GetDocumentParent
static String	GetRelations
static String	LockDocument
static String	MoveDocument
static String	PublishDocument
static String	Query
static String	RemoveAcl
static String	RemoveBlob
static String	RemoveProperty
protected Session	session
static String	SetBlob
static String	SetDocumentState
static String	SetPermission
static String	SetProperty
static String	UnlockDocument
static String	UpdateDocument

Constructor Summary

Constructors

Constructor and Description
DocumentService(Session session)

Method Summary

Modifier and Type	Method and Description
Document	copy(DocRef src, DocRef targetParent)
Document	copy(DocRef src, DocRef targetParent, String name)
Document	createDocument(DocRef parent, String type, String name)
Document	createDocument(DocRef parent, String type, String name, PropertyMap properties) Deprecated. since 9.1 use createDocument(String, Document) or createDocument(DocRef, String, String) instead as instances of PropertyMap is now read-only.
Document	createDocument(String parent, Document document)
Document	createRelation(DocRef subject, String predicate, DocRef object)
Document	createVersion(DocRef doc)
Document	createVersion(DocRef doc, String increment) Increment is one of "None", "Major", "Minor".
void	fireEvent(DocRef doc, String event)
void	fireEvent(String event)
FileBlob	getBlob(DocRef doc)
FileBlob	getBlob(DocRef doc, String xpath)
Blobs	getBlobs(DocRef doc)
Blobs	getBlobs(DocRef doc, String xpath)
Document	getChild(DocRef docRef, String name)
Documents	getChildren(DocRef docRef)
Document	getDocument(DocRef ref)
Document	getDocument(DocRef ref, String schemas)
Document	getDocument(Document document, String... schemas)
Document	getDocument(String ref)
Document	getParent(DocRef docRef)
Documents	getParent(DocRef docRef, String type)
Documents	getRelations(DocRef doc, String predicate)
Documents	getRelations(DocRef doc, String predicate, boolean outgoing)
Documents	getRelations(DocRef doc, String predicate, boolean outgoing, String graphName)
Document	getRootDocument()
Session	getSession()
Document	lock(DocRef doc)
Document	lock(DocRef doc, String lock)
Document	move(DocRef src, DocRef targetParent)
Document	move(DocRef src, DocRef targetParent, String name)
Document	publish(DocRef doc, DocRef section)
Document	publish(DocRef doc, DocRef section, boolean override)
Documents	query(String query)
void	remove(DocRef doc)
void	remove(Document document)
void	remove(String ref)
Document	removeAcl(DocRef doc, String acl)
void	removeBlob(DocRef doc)
void	removeBlob(DocRef doc, String xpath)
Document	removeProperty(DocRef doc, String key)
void	setBlob(DocRef doc, Blob blob)
void	setBlob(DocRef doc, Blob blob, String xpath)
Document	setPermission(DocRef doc, String user, String permission)
Document	setPermission(DocRef doc, String user, String permission, boolean granted)
Document	setPermission(DocRef doc, String user, String permission, String acl, boolean granted)
Document	setProperty(DocRef doc, String key, String value)
Document	setState(DocRef doc, String state)
Document	unlock(DocRef doc)
Document	update(DocRef doc, PropertyMap properties) Deprecated. since 9.1 use update(Document) instead as instances of PropertyMap is now read-only.
Document	update(Document document) This method sends the dirty properties to server

Methods inherited from class java.lang.Object

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

Field Detail

FetchDocument

public static final String FetchDocument

See Also:

Constant Field Values

CreateDocument

public static final String CreateDocument

See Also:

Constant Field Values

DeleteDocument

public static final String DeleteDocument

See Also:

Constant Field Values

CopyDocument

public static final String CopyDocument

See Also:

Constant Field Values

MoveDocument

public static final String MoveDocument

See Also:

Constant Field Values

GetDocumentChildren

public static final String GetDocumentChildren

See Also:

Constant Field Values

GetDocumentChild

public static final String GetDocumentChild

See Also:

Constant Field Values

GetDocumentParent

public static final String GetDocumentParent

See Also:

Constant Field Values

Query

public static final String Query

See Also:

Constant Field Values

SetPermission

public static final String SetPermission

See Also:

Constant Field Values

RemoveAcl

public static final String RemoveAcl

See Also:

Constant Field Values

SetDocumentState

public static final String SetDocumentState

See Also:

Constant Field Values

LockDocument

public static final String LockDocument

See Also:

Constant Field Values

UnlockDocument

public static final String UnlockDocument

See Also:

Constant Field Values

SetProperty

public static final String SetProperty

See Also:

Constant Field Values

RemoveProperty

public static final String RemoveProperty

See Also:

Constant Field Values

UpdateDocument

public static final String UpdateDocument

See Also:

Constant Field Values

PublishDocument

public static final String PublishDocument

See Also:

Constant Field Values

CreateRelation

public static final String CreateRelation

See Also:

Constant Field Values

GetRelations

public static final String GetRelations

See Also:

Constant Field Values

SetBlob

public static final String SetBlob

See Also:

Constant Field Values

RemoveBlob

public static final String RemoveBlob

See Also:

Constant Field Values

GetBlob

public static final String GetBlob

See Also:

Constant Field Values

GetBlobs

public static final String GetBlobs

See Also:

Constant Field Values

CreateVersion

public static final String CreateVersion

See Also:

Constant Field Values

FireEvent

public static final String FireEvent

See Also:

Constant Field Values

CheckOut

public static final String CheckOut

See Also:

Constant Field Values

CheckIn

public static final String CheckIn

See Also:

Constant Field Values

session

protected Session session

Constructor Detail

DocumentService

public DocumentService(Session session)

Method Detail

getSession

public Session getSession()

getDocument

public Document getDocument(String ref)
                     throws IOException

Throws:

IOException

getDocument

public Document getDocument(Document document,
                            String... schemas)
                     throws IOException

Parameters:

document - document to fetch

schemas - schemas related to the document to fetch (* for all)

Returns:

the document returned by server

Throws:

IOException

Since:

5.7

getDocument

public Document getDocument(DocRef ref)
                     throws IOException

Throws:

IOException

getDocument

public Document getDocument(DocRef ref,
                            String schemas)
                     throws IOException

Throws:

IOException

getRootDocument

public Document getRootDocument()
                         throws IOException

Throws:

IOException

createDocument

public Document createDocument(String parent,
                               Document document)
                        throws IOException

Parameters:

parent - can be PathRef or IdRef

document - the document to create

Returns:

the document created

Throws:

IOException

Since:

5.7

createDocument

public Document createDocument(DocRef parent,
                               String type,
                               String name)
                        throws IOException

Throws:

IOException

createDocument

@Deprecated
public Document createDocument(DocRef parent,
                                           String type,
                                           String name,
                                           PropertyMap properties)
                                    throws IOException

Deprecated. since 9.1 use createDocument(String, Document) or createDocument(DocRef, String, String) instead as instances of PropertyMap is now read-only.

THIS METHOD IS PART OF PRIVATE API NOW, DON'T USE IT.

Throws:

IOException

remove

public void remove(Document document)
            throws IOException

Parameters:

document - the document to remove

Throws:

IOException

Since:

5.7

remove

public void remove(DocRef doc)
            throws IOException

Throws:

IOException

remove

public void remove(String ref)
            throws IOException

Throws:

IOException

copy

public Document copy(DocRef src,
                     DocRef targetParent)
              throws IOException

Throws:

IOException

copy

public Document copy(DocRef src,
                     DocRef targetParent,
                     String name)
              throws IOException

Throws:

IOException

move

public Document move(DocRef src,
                     DocRef targetParent)
              throws IOException

Throws:

IOException

move

public Document move(DocRef src,
                     DocRef targetParent,
                     String name)
              throws IOException

Throws:

IOException

getChildren

public Documents getChildren(DocRef docRef)
                      throws IOException

Throws:

IOException

getChild

public Document getChild(DocRef docRef,
                         String name)
                  throws IOException

Throws:

IOException

getParent

public Document getParent(DocRef docRef)
                   throws IOException

Throws:

IOException

getParent

public Documents getParent(DocRef docRef,
                           String type)
                    throws IOException

Throws:

IOException

query

public Documents query(String query)
                throws IOException

Throws:

IOException

setPermission

public Document setPermission(DocRef doc,
                              String user,
                              String permission)
                       throws IOException

Throws:

IOException

setPermission

public Document setPermission(DocRef doc,
                              String user,
                              String permission,
                              boolean granted)
                       throws IOException

Throws:

IOException

setPermission

public Document setPermission(DocRef doc,
                              String user,
                              String permission,
                              String acl,
                              boolean granted)
                       throws IOException

Throws:

IOException

removeAcl

public Document removeAcl(DocRef doc,
                          String acl)
                   throws IOException

Throws:

IOException

setState

public Document setState(DocRef doc,
                         String state)
                  throws IOException

Throws:

IOException

lock

public Document lock(DocRef doc)
              throws IOException

Throws:

IOException

lock

public Document lock(DocRef doc,
                     String lock)
              throws IOException

Throws:

IOException

unlock

public Document unlock(DocRef doc)
                throws IOException

Throws:

IOException

setProperty

public Document setProperty(DocRef doc,
                            String key,
                            String value)
                     throws IOException

Throws:

IOException

removeProperty

public Document removeProperty(DocRef doc,
                               String key)
                        throws IOException

Throws:

IOException

update

public Document update(Document document)
                throws IOException

This method sends the dirty properties to server

Parameters:

document - the document to update

Returns:

the document returned by the server

Throws:

IOException

Since:

5.7

update

@Deprecated
public Document update(DocRef doc,
                                   PropertyMap properties)
                            throws IOException

Deprecated. since 9.1 use update(Document) instead as instances of PropertyMap is now read-only.

Throws:

IOException

publish

public Document publish(DocRef doc,
                        DocRef section)
                 throws IOException

Throws:

IOException

publish

public Document publish(DocRef doc,
                        DocRef section,
                        boolean override)
                 throws IOException

Throws:

IOException

createRelation

public Document createRelation(DocRef subject,
                               String predicate,
                               DocRef object)
                        throws IOException

Throws:

IOException

getRelations

public Documents getRelations(DocRef doc,
                              String predicate)
                       throws IOException

Throws:

IOException

getRelations

public Documents getRelations(DocRef doc,
                              String predicate,
                              boolean outgoing)
                       throws IOException

Throws:

IOException

getRelations

public Documents getRelations(DocRef doc,
                              String predicate,
                              boolean outgoing,
                              String graphName)
                       throws IOException

Throws:

IOException

Since:

5.5

setBlob

public void setBlob(DocRef doc,
                    Blob blob)
             throws IOException

Throws:

IOException

setBlob

public void setBlob(DocRef doc,
                    Blob blob,
                    String xpath)
             throws IOException

Throws:

IOException

removeBlob

public void removeBlob(DocRef doc)
                throws IOException

Throws:

IOException

removeBlob

public void removeBlob(DocRef doc,
                       String xpath)
                throws IOException

Throws:

IOException

getBlob

public FileBlob getBlob(DocRef doc)
                 throws IOException

Throws:

IOException

getBlob

public FileBlob getBlob(DocRef doc,
                        String xpath)
                 throws IOException

Throws:

IOException

getBlobs

public Blobs getBlobs(DocRef doc)
               throws IOException

Throws:

IOException

getBlobs

public Blobs getBlobs(DocRef doc,
                      String xpath)
               throws IOException

Throws:

IOException

createVersion

public Document createVersion(DocRef doc)
                       throws IOException

Throws:

IOException

createVersion

public Document createVersion(DocRef doc,
                              String increment)
                       throws IOException

Increment is one of "None", "Major", "Minor". If null the server default will be used. See VersionIncrement

Throws:

IOException

fireEvent

public void fireEvent(String event)
               throws IOException

Throws:

IOException

fireEvent

public void fireEvent(DocRef doc,
                      String event)
               throws IOException

Throws:

IOException