com.liferay.sync.service

Interface SyncDLObjectService

All Superinterfaces:

BaseService

All Known Implementing Classes:

SyncDLObjectServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface SyncDLObjectService
extends BaseService

Provides the remote service interface for SyncDLObject. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

SyncDLObjectServiceUtil

Method Summary

Modifier and Type	Method and Description
SyncDLObject	addFileEntry(long repositoryId, long folderId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, java.io.File file, java.lang.String checksum, ServiceContext serviceContext)
SyncDLObject	addFolder(long repositoryId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
SyncDLObject	cancelCheckOut(long fileEntryId)
SyncDLObject	checkInFileEntry(long fileEntryId, boolean majorVersion, java.lang.String changeLog, ServiceContext serviceContext)
SyncDLObject	checkOutFileEntry(long fileEntryId, ServiceContext serviceContext)
SyncDLObject	checkOutFileEntry(long fileEntryId, java.lang.String owner, long expirationTime, ServiceContext serviceContext)
SyncDLObject	copyFileEntry(long sourceFileEntryId, long repositoryId, long folderId, java.lang.String sourceFileName, java.lang.String title, ServiceContext serviceContext)
java.util.List<SyncDLObject>	getAllFolderSyncDLObjects(long repositoryId)
SyncDLObject	getFileEntrySyncDLObject(long repositoryId, long folderId, java.lang.String title)
java.util.List<SyncDLObject>	getFileEntrySyncDLObjects(long repositoryId, long folderId)
SyncDLObject	getFolderSyncDLObject(long folderId)
SyncDLObject	getFolderSyncDLObject(long repositoryId, long parentFolderId, java.lang.String name)
java.util.List<SyncDLObject>	getFolderSyncDLObjects(long repositoryId, long parentFolderId)
Group	getGroup(long groupId)
long	getLatestModifiedTime()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
java.lang.Object	getSyncContext()
java.lang.String	getSyncDLObjectUpdate(long repositoryId, long lastAccessTime, int max)
java.lang.String	getSyncDLObjectUpdate(long repositoryId, long lastAccessTime, int max, boolean retrieveFromCache)
java.lang.String	getSyncDLObjectUpdate(long repositoryId, long parentFolderId, long lastAccessTime)
java.util.List<Group>	getUserSitesGroups()
SyncDLObject	moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext)
SyncDLObject	moveFileEntryToTrash(long fileEntryId)
SyncDLObject	moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext)
SyncDLObject	moveFolderToTrash(long folderId)
SyncDLObject	patchFileEntry(long fileEntryId, long sourceVersionId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, java.io.File deltaFile, java.lang.String checksum, ServiceContext serviceContext)
SyncDLObject	restoreFileEntryFromTrash(long fileEntryId)
SyncDLObject	restoreFolderFromTrash(long folderId)
java.util.Map<java.lang.String,java.lang.Object>	updateFileEntries(java.io.File zipFile)
SyncDLObject	updateFileEntry(long fileEntryId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, java.io.File file, java.lang.String checksum, ServiceContext serviceContext)
SyncDLObject	updateFolder(long folderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)

Method Detail

addFileEntry

SyncDLObject addFileEntry(long repositoryId,
                          long folderId,
                          java.lang.String sourceFileName,
                          java.lang.String mimeType,
                          java.lang.String title,
                          java.lang.String description,
                          java.lang.String changeLog,
                          java.io.File file,
                          java.lang.String checksum,
                          ServiceContext serviceContext)
                   throws PortalException

Throws:

PortalException

addFolder

SyncDLObject addFolder(long repositoryId,
                       long parentFolderId,
                       java.lang.String name,
                       java.lang.String description,
                       ServiceContext serviceContext)
                throws PortalException

Throws:

PortalException

cancelCheckOut

SyncDLObject cancelCheckOut(long fileEntryId)
                     throws PortalException

Throws:

PortalException

checkInFileEntry

SyncDLObject checkInFileEntry(long fileEntryId,
                              boolean majorVersion,
                              java.lang.String changeLog,
                              ServiceContext serviceContext)
                       throws PortalException

Throws:

PortalException

checkOutFileEntry

SyncDLObject checkOutFileEntry(long fileEntryId,
                               ServiceContext serviceContext)
                        throws PortalException

Throws:

PortalException

checkOutFileEntry

SyncDLObject checkOutFileEntry(long fileEntryId,
                               java.lang.String owner,
                               long expirationTime,
                               ServiceContext serviceContext)
                        throws PortalException

Throws:

PortalException

copyFileEntry

SyncDLObject copyFileEntry(long sourceFileEntryId,
                           long repositoryId,
                           long folderId,
                           java.lang.String sourceFileName,
                           java.lang.String title,
                           ServiceContext serviceContext)
                    throws PortalException

Throws:

PortalException

getAllFolderSyncDLObjects

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SyncDLObject> getAllFolderSyncDLObjects(long repositoryId)
                                                                                                                   throws PortalException

Throws:

PortalException

getFileEntrySyncDLObject

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SyncDLObject getFileEntrySyncDLObject(long repositoryId,
                                                                                                         long folderId,
                                                                                                         java.lang.String title)
                                                                                                  throws PortalException

Throws:

PortalException

getFileEntrySyncDLObjects

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SyncDLObject> getFileEntrySyncDLObjects(long repositoryId,
                                                                                                                          long folderId)
                                                                                                                   throws PortalException

Throws:

PortalException

getFolderSyncDLObject

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SyncDLObject getFolderSyncDLObject(long folderId)
                                                                                               throws PortalException

Throws:

PortalException

getFolderSyncDLObject

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SyncDLObject getFolderSyncDLObject(long repositoryId,
                                                                                                      long parentFolderId,
                                                                                                      java.lang.String name)
                                                                                               throws PortalException

Throws:

PortalException

getFolderSyncDLObjects

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SyncDLObject> getFolderSyncDLObjects(long repositoryId,
                                                                                                                       long parentFolderId)
                                                                                                                throws PortalException

Throws:

PortalException

getGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group getGroup(long groupId)
                                                                           throws PortalException

Throws:

PortalException

getLatestModifiedTime

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getLatestModifiedTime()
                                                                                       throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getSyncContext

@AccessControlled(guestAccessEnabled=true)
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.Object getSyncContext()
                                                                                                                                        throws PortalException

Throws:

PortalException

getSyncDLObjectUpdate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String getSyncDLObjectUpdate(long repositoryId,
                                                                                                          long lastAccessTime,
                                                                                                          int max)
                                                                                                   throws PortalException

Throws:

PortalException

getSyncDLObjectUpdate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String getSyncDLObjectUpdate(long repositoryId,
                                                                                                          long lastAccessTime,
                                                                                                          int max,
                                                                                                          boolean retrieveFromCache)
                                                                                                   throws PortalException

Throws:

PortalException

getSyncDLObjectUpdate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String getSyncDLObjectUpdate(long repositoryId,
                                                                                                          long parentFolderId,
                                                                                                          long lastAccessTime)
                                                                                                   throws PortalException

Throws:

PortalException

getUserSitesGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserSitesGroups()
                                                                                                     throws PortalException

Throws:

PortalException

moveFileEntry

SyncDLObject moveFileEntry(long fileEntryId,
                           long newFolderId,
                           ServiceContext serviceContext)
                    throws PortalException

Throws:

PortalException

moveFileEntryToTrash

SyncDLObject moveFileEntryToTrash(long fileEntryId)
                           throws PortalException

Throws:

PortalException

moveFolder

SyncDLObject moveFolder(long folderId,
                        long parentFolderId,
                        ServiceContext serviceContext)
                 throws PortalException

Throws:

PortalException

moveFolderToTrash

SyncDLObject moveFolderToTrash(long folderId)
                        throws PortalException

Throws:

PortalException

patchFileEntry

SyncDLObject patchFileEntry(long fileEntryId,
                            long sourceVersionId,
                            java.lang.String sourceFileName,
                            java.lang.String mimeType,
                            java.lang.String title,
                            java.lang.String description,
                            java.lang.String changeLog,
                            boolean majorVersion,
                            java.io.File deltaFile,
                            java.lang.String checksum,
                            ServiceContext serviceContext)
                     throws PortalException

Throws:

PortalException

restoreFileEntryFromTrash

SyncDLObject restoreFileEntryFromTrash(long fileEntryId)
                                throws PortalException

Throws:

PortalException

restoreFolderFromTrash

SyncDLObject restoreFolderFromTrash(long folderId)
                             throws PortalException

Throws:

PortalException

updateFileEntries

@Transactional(enabled=false)
java.util.Map<java.lang.String,java.lang.Object> updateFileEntries(java.io.File zipFile)
                                                                                          throws PortalException

Throws:

PortalException

updateFileEntry

SyncDLObject updateFileEntry(long fileEntryId,
                             java.lang.String sourceFileName,
                             java.lang.String mimeType,
                             java.lang.String title,
                             java.lang.String description,
                             java.lang.String changeLog,
                             boolean majorVersion,
                             java.io.File file,
                             java.lang.String checksum,
                             ServiceContext serviceContext)
                      throws PortalException

Throws:

PortalException

updateFolder

SyncDLObject updateFolder(long folderId,
                          java.lang.String name,
                          java.lang.String description,
                          ServiceContext serviceContext)
                   throws PortalException

Throws:

PortalException