org.alfresco.repo.webservice.authoring

Class AuthoringWebService

java.lang.Object

org.alfresco.repo.webservice.AbstractWebService

org.alfresco.repo.webservice.authoring.AuthoringWebService

All Implemented Interfaces:

Remote, AuthoringServiceSoapPort

public class AuthoringWebService
extends AbstractWebService
implements AuthoringServiceSoapPort

Web service implementation of the AuthoringService. The WSDL for this service can be accessed from http://localhost:8080/alfresco/wsdl/authoring-service.wsdl

Author:

gavinc

Field Summary

Fields inherited from class org.alfresco.repo.webservice.AbstractWebService

contentService, dictionaryService, namespaceService, nodeService, querySessionCache, searchService, serviceRegistry

Constructor Summary

Constructors

Constructor and Description
AuthoringWebService()

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 node, 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, String versionLabel) Revert a node to the snapshot of the specified version.
void	setCheckOutCheckinService(CheckOutCheckInService cociService) Sets the CheckInCheckOutService to use
void	setLockService(LockService lockService) Sets the LockService to use
void	setTransactionService(TransactionService transactionService) Set the transaction service
void	setVersionService(VersionService versionService) Set the version service
Reference[]	unlock(Predicate items, boolean unlockChildren) Unlocks a content resource.

Methods inherited from class org.alfresco.repo.webservice.AbstractWebService

setContentService, setDictionaryService, setNamespaceService, setNodeService, setQuerySessionCache, setSearchService, setServiceRegistry

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthoringWebService

public AuthoringWebService()

Method Detail

setCheckOutCheckinService

public void setCheckOutCheckinService(CheckOutCheckInService cociService)

Sets the CheckInCheckOutService to use

Parameters:

cociService - The CheckInCheckOutService

setLockService

public void setLockService(LockService lockService)

Sets the LockService to use

Parameters:

lockService - the lock service

setVersionService

public void setVersionService(VersionService versionService)

Set the version service

Parameters:

versionService - the version service

setTransactionService

public void setTransactionService(TransactionService transactionService)

Set the transaction service

Parameters:

transactionService - the transaction service

checkout

public CheckoutResult checkout(Predicate items,
                      ParentReference destination)
                        throws RemoteException,
                               AuthoringFault

Description copied from interface: AuthoringServiceSoapPort

Checkout a content resource for editing.

Specified by:

checkout in interface AuthoringServiceSoapPort

Throws:

RemoteException

AuthoringFault

See Also:

AuthoringServiceSoapPort.checkout(org.alfresco.repo.webservice.types.Predicate, org.alfresco.repo.webservice.types.ParentReference)

checkin

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

Description copied from interface: AuthoringServiceSoapPort

Checkin a content resource.

Specified by:

checkin in interface AuthoringServiceSoapPort

Throws:

RemoteException

AuthoringFault

See Also:

AuthoringServiceSoapPort.checkin(org.alfresco.repo.webservice.types.Predicate, org.alfresco.repo.webservice.types.NamedValue[], boolean)

checkinExternal

public Reference checkinExternal(Reference node,
                        NamedValue[] comments,
                        boolean keepCheckedOut,
                        ContentFormat format,
                        byte[] content)
                          throws RemoteException,
                                 AuthoringFault

Description copied from interface: AuthoringServiceSoapPort

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

Specified by:

checkinExternal in interface AuthoringServiceSoapPort

Throws:

RemoteException

AuthoringFault

See Also:

AuthoringServiceSoapPort.checkinExternal(org.alfresco.repo.webservice.types.Reference, org.alfresco.repo.webservice.types.NamedValue[], boolean, org.alfresco.repo.webservice.types.ContentFormat, byte[])

cancelCheckout

public CancelCheckoutResult cancelCheckout(Predicate items)
                                    throws RemoteException,
                                           AuthoringFault

Description copied from interface: AuthoringServiceSoapPort

Cancels the checkout.

Specified by:

cancelCheckout in interface AuthoringServiceSoapPort

Throws:

RemoteException

AuthoringFault

See Also:

AuthoringServiceSoapPort.cancelCheckout(org.alfresco.repo.webservice.types.Predicate)

lock

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

Description copied from interface: AuthoringServiceSoapPort

Locks a content resource.

Specified by:

lock in interface AuthoringServiceSoapPort

Throws:

RemoteException

AuthoringFault

See Also:

AuthoringServiceSoapPort.lock(org.alfresco.repo.webservice.types.Predicate, boolean, org.alfresco.repo.webservice.authoring.LockTypeEnum)

unlock

public Reference[] unlock(Predicate items,
                 boolean unlockChildren)
                   throws RemoteException,
                          AuthoringFault

Description copied from interface: AuthoringServiceSoapPort

Unlocks a content resource.

Specified by:

unlock in interface AuthoringServiceSoapPort

Throws:

RemoteException

AuthoringFault

See Also:

AuthoringServiceSoapPort.unlock(org.alfresco.repo.webservice.types.Predicate, boolean)

getLockStatus

public LockStatus[] getLockStatus(Predicate items)
                           throws RemoteException,
                                  AuthoringFault

Description copied from interface: AuthoringServiceSoapPort

Gets the lock status of the specified nodes.

Specified by:

getLockStatus in interface AuthoringServiceSoapPort

Throws:

RemoteException

AuthoringFault

See Also:

AuthoringServiceSoapPort.getLockStatus(org.alfresco.repo.webservice.types.Predicate)

createVersion

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

Description copied from interface: AuthoringServiceSoapPort

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

Specified by:

createVersion in interface AuthoringServiceSoapPort

Throws:

RemoteException

AuthoringFault

See Also:

AuthoringServiceSoapPort.createVersion(org.alfresco.repo.webservice.types.Predicate, org.alfresco.repo.webservice.types.NamedValue[], boolean)

getVersionHistory

public VersionHistory getVersionHistory(Reference node)
                                 throws RemoteException,
                                        AuthoringFault

Description copied from interface: AuthoringServiceSoapPort

Gets the version history for the specfied node.

Specified by:

getVersionHistory in interface AuthoringServiceSoapPort

Throws:

RemoteException

AuthoringFault

See Also:

AuthoringServiceSoapPort.getVersionHistory(org.alfresco.repo.webservice.types.Reference)

revertVersion

public void revertVersion(Reference node,
                 String versionLabel)
                   throws RemoteException,
                          AuthoringFault

Description copied from interface: AuthoringServiceSoapPort

Revert a node to the snapshot of the specified version.

Specified by:

revertVersion in interface AuthoringServiceSoapPort

Throws:

RemoteException

AuthoringFault

See Also:

AuthoringServiceSoapPort.revertVersion(org.alfresco.repo.webservice.types.Reference, java.lang.String)

deleteAllVersions

public VersionHistory deleteAllVersions(Reference node)
                                 throws RemoteException,
                                        AuthoringFault

Description copied from interface: AuthoringServiceSoapPort

Delete all snapshot versions of the specified node.

Specified by:

deleteAllVersions in interface AuthoringServiceSoapPort

Throws:

RemoteException

AuthoringFault

See Also:

AuthoringServiceSoapPort.deleteAllVersions(org.alfresco.repo.webservice.types.Reference)