AuthoringServiceSoapPort (Alfresco Remote API 5.0.a API)

All Superinterfaces:

Remote

All Known Implementing Classes:

AuthoringWebService
```
public interface AuthoringServiceSoapPort
extends 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, 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 RemoteException,
                               AuthoringFault

Checkout a content resource for editing.

Throws:: RemoteException; AuthoringFault

checkin

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

Checkin a content resource.

Throws:: RemoteException; AuthoringFault

checkinExternal

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

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

Throws:: RemoteException; AuthoringFault

cancelCheckout

CancelCheckoutResult cancelCheckout(Predicate items)
                                    throws RemoteException,
                                           AuthoringFault

Cancels the checkout.

Throws:: RemoteException; AuthoringFault

lock

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

Locks a content resource.

Throws:: RemoteException; AuthoringFault

unlock

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

Unlocks a content resource.

Throws:: RemoteException; AuthoringFault

getLockStatus

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

Gets the lock status of the specified nodes.

Throws:: RemoteException; AuthoringFault

createVersion

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

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

Throws:: RemoteException; AuthoringFault

getVersionHistory

VersionHistory getVersionHistory(Reference node)
                                 throws RemoteException,
                                        AuthoringFault

Gets the version history for the specfied node.

Throws:: RemoteException; AuthoringFault

revertVersion

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

Revert a node to the snapshot of the specified version.

Throws:: RemoteException; AuthoringFault

deleteAllVersions

VersionHistory deleteAllVersions(Reference node)
                                 throws RemoteException,
                                        AuthoringFault

Delete all snapshot versions of the specified node.

Throws:: RemoteException; AuthoringFault

Interface AuthoringServiceSoapPort