org.alfresco.repo.webservice.authoring

Class AuthoringWebService

java.lang.Object

org.alfresco.repo.webservice.AbstractWebService

org.alfresco.repo.webservice.authoring.AuthoringWebService

All Implemented Interfaces:

java.rmi.Remote, org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

public class AuthoringWebService
extends AbstractWebService
implements org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

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

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
org.alfresco.repo.webservice.authoring.CancelCheckoutResult	cancelCheckout(org.alfresco.repo.webservice.types.Predicate items)
org.alfresco.repo.webservice.authoring.CheckinResult	checkin(org.alfresco.repo.webservice.types.Predicate items, org.alfresco.repo.webservice.types.NamedValue[] comments, boolean keepCheckedOut)
org.alfresco.repo.webservice.types.Reference	checkinExternal(org.alfresco.repo.webservice.types.Reference node, org.alfresco.repo.webservice.types.NamedValue[] comments, boolean keepCheckedOut, org.alfresco.repo.webservice.types.ContentFormat format, byte[] content)
org.alfresco.repo.webservice.authoring.CheckoutResult	checkout(org.alfresco.repo.webservice.types.Predicate items, org.alfresco.repo.webservice.types.ParentReference destination)
org.alfresco.repo.webservice.authoring.VersionResult	createVersion(org.alfresco.repo.webservice.types.Predicate items, org.alfresco.repo.webservice.types.NamedValue[] comments, boolean versionChildren)
org.alfresco.repo.webservice.types.VersionHistory	deleteAllVersions(org.alfresco.repo.webservice.types.Reference node)
org.alfresco.repo.webservice.authoring.LockStatus[]	getLockStatus(org.alfresco.repo.webservice.types.Predicate items)
org.alfresco.repo.webservice.types.VersionHistory	getVersionHistory(org.alfresco.repo.webservice.types.Reference node)
org.alfresco.repo.webservice.types.Reference[]	lock(org.alfresco.repo.webservice.types.Predicate items, boolean lockChildren, org.alfresco.repo.webservice.authoring.LockTypeEnum lockType)
void	revertVersion(org.alfresco.repo.webservice.types.Reference node, java.lang.String versionLabel)
void	setCheckOutCheckinService(org.alfresco.service.cmr.coci.CheckOutCheckInService cociService) Sets the CheckInCheckOutService to use
void	setLockService(org.alfresco.service.cmr.lock.LockService lockService) Sets the LockService to use
void	setTransactionService(org.alfresco.service.transaction.TransactionService transactionService) Set the transaction service
void	setVersionService(org.alfresco.service.cmr.version.VersionService versionService) Set the version service
org.alfresco.repo.webservice.types.Reference[]	unlock(org.alfresco.repo.webservice.types.Predicate items, boolean unlockChildren)

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(org.alfresco.service.cmr.coci.CheckOutCheckInService cociService)

Sets the CheckInCheckOutService to use

Parameters:

cociService - The CheckInCheckOutService

setLockService

public void setLockService(org.alfresco.service.cmr.lock.LockService lockService)

Sets the LockService to use

Parameters:

lockService - the lock service

setVersionService

public void setVersionService(org.alfresco.service.cmr.version.VersionService versionService)

Set the version service

Parameters:

versionService - the version service

setTransactionService

public void setTransactionService(org.alfresco.service.transaction.TransactionService transactionService)

Set the transaction service

Parameters:

transactionService - the transaction service

checkout

public org.alfresco.repo.webservice.authoring.CheckoutResult checkout(org.alfresco.repo.webservice.types.Predicate items,
                                                             org.alfresco.repo.webservice.types.ParentReference destination)
                                                               throws java.rmi.RemoteException,
                                                                      org.alfresco.repo.webservice.authoring.AuthoringFault

Specified by:

checkout in interface org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

Throws:

java.rmi.RemoteException

org.alfresco.repo.webservice.authoring.AuthoringFault

See Also:

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

checkin

public org.alfresco.repo.webservice.authoring.CheckinResult checkin(org.alfresco.repo.webservice.types.Predicate items,
                                                           org.alfresco.repo.webservice.types.NamedValue[] comments,
                                                           boolean keepCheckedOut)
                                                             throws java.rmi.RemoteException,
                                                                    org.alfresco.repo.webservice.authoring.AuthoringFault

Specified by:

checkin in interface org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

Throws:

java.rmi.RemoteException

org.alfresco.repo.webservice.authoring.AuthoringFault

See Also:

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

checkinExternal

public org.alfresco.repo.webservice.types.Reference checkinExternal(org.alfresco.repo.webservice.types.Reference node,
                                                           org.alfresco.repo.webservice.types.NamedValue[] comments,
                                                           boolean keepCheckedOut,
                                                           org.alfresco.repo.webservice.types.ContentFormat format,
                                                           byte[] content)
                                                             throws java.rmi.RemoteException,
                                                                    org.alfresco.repo.webservice.authoring.AuthoringFault

Specified by:

checkinExternal in interface org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

Throws:

java.rmi.RemoteException

org.alfresco.repo.webservice.authoring.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 org.alfresco.repo.webservice.authoring.CancelCheckoutResult cancelCheckout(org.alfresco.repo.webservice.types.Predicate items)
                                                                           throws java.rmi.RemoteException,
                                                                                  org.alfresco.repo.webservice.authoring.AuthoringFault

Specified by:

cancelCheckout in interface org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

Throws:

java.rmi.RemoteException

org.alfresco.repo.webservice.authoring.AuthoringFault

See Also:

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

lock

public org.alfresco.repo.webservice.types.Reference[] lock(org.alfresco.repo.webservice.types.Predicate items,
                                                  boolean lockChildren,
                                                  org.alfresco.repo.webservice.authoring.LockTypeEnum lockType)
                                                    throws java.rmi.RemoteException,
                                                           org.alfresco.repo.webservice.authoring.AuthoringFault

Specified by:

lock in interface org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

Throws:

java.rmi.RemoteException

org.alfresco.repo.webservice.authoring.AuthoringFault

See Also:

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

unlock

public org.alfresco.repo.webservice.types.Reference[] unlock(org.alfresco.repo.webservice.types.Predicate items,
                                                    boolean unlockChildren)
                                                      throws java.rmi.RemoteException,
                                                             org.alfresco.repo.webservice.authoring.AuthoringFault

Specified by:

unlock in interface org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

Throws:

java.rmi.RemoteException

org.alfresco.repo.webservice.authoring.AuthoringFault

See Also:

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

getLockStatus

public org.alfresco.repo.webservice.authoring.LockStatus[] getLockStatus(org.alfresco.repo.webservice.types.Predicate items)
                                                                  throws java.rmi.RemoteException,
                                                                         org.alfresco.repo.webservice.authoring.AuthoringFault

Specified by:

getLockStatus in interface org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

Throws:

java.rmi.RemoteException

org.alfresco.repo.webservice.authoring.AuthoringFault

See Also:

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

createVersion

public org.alfresco.repo.webservice.authoring.VersionResult createVersion(org.alfresco.repo.webservice.types.Predicate items,
                                                                 org.alfresco.repo.webservice.types.NamedValue[] comments,
                                                                 boolean versionChildren)
                                                                   throws java.rmi.RemoteException,
                                                                          org.alfresco.repo.webservice.authoring.AuthoringFault

Specified by:

createVersion in interface org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

Throws:

java.rmi.RemoteException

org.alfresco.repo.webservice.authoring.AuthoringFault

See Also:

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

getVersionHistory

public org.alfresco.repo.webservice.types.VersionHistory getVersionHistory(org.alfresco.repo.webservice.types.Reference node)
                                                                    throws java.rmi.RemoteException,
                                                                           org.alfresco.repo.webservice.authoring.AuthoringFault

Specified by:

getVersionHistory in interface org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

Throws:

java.rmi.RemoteException

org.alfresco.repo.webservice.authoring.AuthoringFault

See Also:

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

revertVersion

public void revertVersion(org.alfresco.repo.webservice.types.Reference node,
                 java.lang.String versionLabel)
                   throws java.rmi.RemoteException,
                          org.alfresco.repo.webservice.authoring.AuthoringFault

Specified by:

revertVersion in interface org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

Throws:

java.rmi.RemoteException

org.alfresco.repo.webservice.authoring.AuthoringFault

See Also:

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

deleteAllVersions

public org.alfresco.repo.webservice.types.VersionHistory deleteAllVersions(org.alfresco.repo.webservice.types.Reference node)
                                                                    throws java.rmi.RemoteException,
                                                                           org.alfresco.repo.webservice.authoring.AuthoringFault

Specified by:

deleteAllVersions in interface org.alfresco.repo.webservice.authoring.AuthoringServiceSoapPort

Throws:

java.rmi.RemoteException

org.alfresco.repo.webservice.authoring.AuthoringFault

See Also:

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