org.alfresco.webservice.authoring

Interface AuthoringServiceSoapPort

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

AuthoringServiceSoapBindingStub

public interface AuthoringServiceSoapPort
extends java.rmi.Remote

Method Summary

Methods

Modifier and Type	Method and Description
CancelCheckoutResult	cancelCheckout(Predicate items) Cancels the checkout.
CheckinResult	checkin(Predicate items, NamedValue[] comments, boolean keepCheckedOut) Checkin a content resource.
Reference	checkinExternal(Reference items, NamedValue[] comments, boolean keepCheckedOut, ContentFormat format, byte[] content) Checkin an external content resource thus replacing the existing working content.
CheckoutResult	checkout(Predicate items, ParentReference destination) Checkout a content resource for editing.
VersionResult	createVersion(Predicate items, NamedValue[] comments, boolean versionChildren) Create a snapshot of the specified node(s) in the version store.
VersionHistory	deleteAllVersions(Reference node) Delete all snapshot versions of the specified node.
LockStatus[]	getLockStatus(Predicate items) Gets the lock status of the specified nodes.
VersionHistory	getVersionHistory(Reference node) Gets the version history for the specfied node.
Reference[]	lock(Predicate items, boolean lockChildren, LockTypeEnum lockType) Locks a content resource.
void	revertVersion(Reference node, java.lang.String versionLabel) Revert a node to the snapshot of the specified version.
Reference[]	unlock(Predicate items, boolean unlockChildren) Unlocks a content resource.

Method Detail

checkout

CheckoutResult checkout(Predicate items,
                      ParentReference destination)
                        throws java.rmi.RemoteException,
                               AuthoringFault

Checkout a content resource for editing.

Throws:

java.rmi.RemoteException

AuthoringFault

checkin

CheckinResult checkin(Predicate items,
                    NamedValue[] comments,
                    boolean keepCheckedOut)
                      throws java.rmi.RemoteException,
                             AuthoringFault

Checkin a content resource.

Throws:

java.rmi.RemoteException

AuthoringFault

checkinExternal

Reference checkinExternal(Reference items,
                        NamedValue[] comments,
                        boolean keepCheckedOut,
                        ContentFormat format,
                        byte[] content)
                          throws java.rmi.RemoteException,
                                 AuthoringFault

Checkin an external content resource thus replacing the existing working content.

Throws:

java.rmi.RemoteException

AuthoringFault

cancelCheckout

CancelCheckoutResult cancelCheckout(Predicate items)
                                    throws java.rmi.RemoteException,
                                           AuthoringFault

Cancels the checkout.

Throws:

java.rmi.RemoteException

AuthoringFault

lock

Reference[] lock(Predicate items,
               boolean lockChildren,
               LockTypeEnum lockType)
                 throws java.rmi.RemoteException,
                        AuthoringFault

Locks a content resource.

Throws:

java.rmi.RemoteException

AuthoringFault

unlock

Reference[] unlock(Predicate items,
                 boolean unlockChildren)
                   throws java.rmi.RemoteException,
                          AuthoringFault

Unlocks a content resource.

Throws:

java.rmi.RemoteException

AuthoringFault

getLockStatus

LockStatus[] getLockStatus(Predicate items)
                           throws java.rmi.RemoteException,
                                  AuthoringFault

Gets the lock status of the specified nodes.

Throws:

java.rmi.RemoteException

AuthoringFault

createVersion

VersionResult createVersion(Predicate items,
                          NamedValue[] comments,
                          boolean versionChildren)
                            throws java.rmi.RemoteException,
                                   AuthoringFault

Create a snapshot of the specified node(s) in the version store.

Throws:

java.rmi.RemoteException

AuthoringFault

getVersionHistory

VersionHistory getVersionHistory(Reference node)
                                 throws java.rmi.RemoteException,
                                        AuthoringFault

Gets the version history for the specfied node.

Throws:

java.rmi.RemoteException

AuthoringFault

revertVersion

void revertVersion(Reference node,
                 java.lang.String versionLabel)
                   throws java.rmi.RemoteException,
                          AuthoringFault

Revert a node to the snapshot of the specified version.

Throws:

java.rmi.RemoteException

AuthoringFault

deleteAllVersions

VersionHistory deleteAllVersions(Reference node)
                                 throws java.rmi.RemoteException,
                                        AuthoringFault

Delete all snapshot versions of the specified node.

Throws:

java.rmi.RemoteException

AuthoringFault