Liferay 6.1.2-ce-ga3

com.liferay.portlet.documentlibrary.service
Interface DLSyncLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
DLSyncLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLSyncLocalService
extends BaseLocalService, PersistedModelLocalService

The interface for the d l sync local service.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:
DLSyncLocalServiceUtil, com.liferay.portlet.documentlibrary.service.base.DLSyncLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLSyncLocalServiceImpl

Method Summary
 DLSync addDLSync(DLSync dlSync)
          Adds the d l sync to the database.
 DLSync addSync(long fileId, String fileUuid, long companyId, long repositoryId, long parentFolderId, String name, String type, String version)
          Deprecated. addSync(long, String, long, long, long, String, String, String, String)
 DLSync addSync(long fileId, String fileUuid, long companyId, long repositoryId, long parentFolderId, String name, String description, String type, String version)
           
 DLSync createDLSync(long syncId)
          Creates a new d l sync with the primary key.
 DLSync deleteDLSync(DLSync dlSync)
          Deletes the d l sync from the database.
 DLSync deleteDLSync(long syncId)
          Deletes the d l sync with the primary key from the database.
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 DLSync fetchDLSync(long syncId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 DLSync getDLSync(long syncId)
          Returns the d l sync with the primary key.
 List<DLSync> getDLSyncs(int start, int end)
          Returns a range of all the d l syncs.
 int getDLSyncsCount()
          Returns the number of d l syncs.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 DLSync updateDLSync(DLSync dlSync)
          Updates the d l sync in the database or adds it if it does not yet exist.
 DLSync updateDLSync(DLSync dlSync, boolean merge)
          Updates the d l sync in the database or adds it if it does not yet exist.
 DLSync updateSync(long fileId, long parentFolderId, String name, String event, String version)
          Deprecated. updateSync(long, long, String, String, String, String)
 DLSync updateSync(long fileId, long parentFolderId, String name, String description, String event, String version)
           
 

Method Detail

addDLSync

DLSync addDLSync(DLSync dlSync)
                 throws SystemException
Adds the d l sync to the database. Also notifies the appropriate model listeners.

Parameters:
dlSync - the d l sync
Returns:
the d l sync that was added
Throws:
SystemException - if a system exception occurred

createDLSync

DLSync createDLSync(long syncId)
Creates a new d l sync with the primary key. Does not add the d l sync to the database.

Parameters:
syncId - the primary key for the new d l sync
Returns:
the new d l sync

deleteDLSync

DLSync deleteDLSync(long syncId)
                    throws PortalException,
                           SystemException
Deletes the d l sync with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
syncId - the primary key of the d l sync
Returns:
the d l sync that was removed
Throws:
PortalException - if a d l sync with the primary key could not be found
SystemException - if a system exception occurred

deleteDLSync

DLSync deleteDLSync(DLSync dlSync)
                    throws SystemException
Deletes the d l sync from the database. Also notifies the appropriate model listeners.

Parameters:
dlSync - the d l sync
Returns:
the d l sync that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchDLSync

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLSync fetchDLSync(long syncId)
                   throws SystemException
Throws:
SystemException

getDLSync

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLSync getDLSync(long syncId)
                 throws PortalException,
                        SystemException
Returns the d l sync with the primary key.

Parameters:
syncId - the primary key of the d l sync
Returns:
the d l sync
Throws:
PortalException - if a d l sync with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getDLSyncs

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLSync> getDLSyncs(int start,
                                                                 int end)
                        throws SystemException
Returns a range of all the d l syncs.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
start - the lower bound of the range of d l syncs
end - the upper bound of the range of d l syncs (not inclusive)
Returns:
the range of d l syncs
Throws:
SystemException - if a system exception occurred

getDLSyncsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDLSyncsCount()
                    throws SystemException
Returns the number of d l syncs.

Returns:
the number of d l syncs
Throws:
SystemException - if a system exception occurred

updateDLSync

DLSync updateDLSync(DLSync dlSync)
                    throws SystemException
Updates the d l sync in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
dlSync - the d l sync
Returns:
the d l sync that was updated
Throws:
SystemException - if a system exception occurred

updateDLSync

DLSync updateDLSync(DLSync dlSync,
                    boolean merge)
                    throws SystemException
Updates the d l sync in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
dlSync - the d l sync
merge - whether to merge the d l sync with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the d l sync that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addSync

DLSync addSync(long fileId,
               String fileUuid,
               long companyId,
               long repositoryId,
               long parentFolderId,
               String name,
               String type,
               String version)
               throws PortalException,
                      SystemException
Deprecated. addSync(long, String, long, long, long, String, String, String, String)

Throws:
PortalException
SystemException

addSync

DLSync addSync(long fileId,
               String fileUuid,
               long companyId,
               long repositoryId,
               long parentFolderId,
               String name,
               String description,
               String type,
               String version)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

updateSync

DLSync updateSync(long fileId,
                  long parentFolderId,
                  String name,
                  String event,
                  String version)
                  throws PortalException,
                         SystemException
Deprecated. updateSync(long, long, String, String, String, String)

Throws:
PortalException
SystemException

updateSync

DLSync updateSync(long fileId,
                  long parentFolderId,
                  String name,
                  String description,
                  String event,
                  String version)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

Liferay 6.1.2-ce-ga3