com.liferay.sync.service

Interface SyncDeviceLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

SyncDeviceLocalServiceWrapper

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

Provides the local service interface for SyncDevice. 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:

SyncDeviceLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
SyncDevice	addSyncDevice(long userId, java.lang.String type, long buildNumber, java.lang.String hostname, int featureSet)
SyncDevice	addSyncDevice(SyncDevice syncDevice) Adds the sync device to the database.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
SyncDevice	createSyncDevice(long syncDeviceId) Creates a new sync device with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
SyncDevice	deleteSyncDevice(long syncDeviceId) Deletes the sync device with the primary key from the database.
SyncDevice	deleteSyncDevice(SyncDevice syncDevice) Deletes the sync device from the database.
<T> T	dslQuery(DSLQuery dslQuery)
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
SyncDevice	fetchSyncDevice(long syncDeviceId)
SyncDevice	fetchSyncDeviceByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the sync device with the matching UUID and company.
ActionableDynamicQuery	getActionableDynamicQuery()
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
SyncDevice	getSyncDevice(long syncDeviceId) Returns the sync device with the primary key.
SyncDevice	getSyncDeviceByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the sync device with the matching UUID and company.
java.util.List<SyncDevice>	getSyncDevices(int start, int end) Returns a range of all the sync devices.
java.util.List<SyncDevice>	getSyncDevices(long userId, int start, int end, OrderByComparator<SyncDevice> orderByComparator)
int	getSyncDevicesCount() Returns the number of sync devices.
java.util.List<SyncDevice>	search(long companyId, java.lang.String keywords, int start, int end, OrderByComparator<SyncDevice> orderByComparator)
void	updateStatus(long syncDeviceId, int status)
SyncDevice	updateSyncDevice(long syncDeviceId, java.lang.String type, long buildNumber, int featureSet, java.lang.String hostname, int status)
SyncDevice	updateSyncDevice(SyncDevice syncDevice) Updates the sync device in the database or adds it if it does not yet exist.

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addSyncDevice

SyncDevice addSyncDevice(long userId,
                         java.lang.String type,
                         long buildNumber,
                         java.lang.String hostname,
                         int featureSet)
                  throws PortalException

Throws:

PortalException

addSyncDevice

@Indexable(type=REINDEX)
SyncDevice addSyncDevice(SyncDevice syncDevice)

Adds the sync device to the database. Also notifies the appropriate model listeners.

Important: Inspect SyncDeviceLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

syncDevice - the sync device

Returns:

the sync device that was added

createPersistedModel

PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                             throws PortalException

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

createSyncDevice

@Transactional(enabled=false)
SyncDevice createSyncDevice(long syncDeviceId)

Creates a new sync device with the primary key. Does not add the sync device to the database.

Parameters:

syncDeviceId - the primary key for the new sync device

Returns:

the new sync device

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteSyncDevice

@Indexable(type=DELETE)
SyncDevice deleteSyncDevice(long syncDeviceId)
                                             throws PortalException

Deletes the sync device with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect SyncDeviceLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

syncDeviceId - the primary key of the sync device

Returns:

the sync device that was removed

Throws:

PortalException - if a sync device with the primary key could not be found

deleteSyncDevice

@Indexable(type=DELETE)
SyncDevice deleteSyncDevice(SyncDevice syncDevice)

Deletes the sync device from the database. Also notifies the appropriate model listeners.

Important: Inspect SyncDeviceLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

syncDevice - the sync device

Returns:

the sync device that was removed

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end)

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.sync.model.impl.SyncDeviceModelImpl.

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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      OrderByComparator<T> orderByComparator)

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.sync.model.impl.SyncDeviceModelImpl.

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

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchSyncDevice

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SyncDevice fetchSyncDevice(long syncDeviceId)

fetchSyncDeviceByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SyncDevice fetchSyncDeviceByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                long companyId)

Returns the sync device with the matching UUID and company.

Parameters:

uuid - the sync device's UUID

companyId - the primary key of the company

Returns:

the matching sync device, or null if a matching sync device could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getSyncDevice

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SyncDevice getSyncDevice(long syncDeviceId)
                                                                                     throws PortalException

Returns the sync device with the primary key.

Parameters:

syncDeviceId - the primary key of the sync device

Returns:

the sync device

Throws:

PortalException - if a sync device with the primary key could not be found

getSyncDeviceByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SyncDevice getSyncDeviceByUuidAndCompanyId(java.lang.String uuid,
                                                                                                              long companyId)
                                                                                                       throws PortalException

Returns the sync device with the matching UUID and company.

Parameters:

uuid - the sync device's UUID

companyId - the primary key of the company

Returns:

the matching sync device

Throws:

PortalException - if a matching sync device could not be found

getSyncDevices

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SyncDevice> getSyncDevices(int start,
                                                                                                             int end)

Returns a range of all the sync devices.

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.sync.model.impl.SyncDeviceModelImpl.

Parameters:

start - the lower bound of the range of sync devices

end - the upper bound of the range of sync devices (not inclusive)

Returns:

the range of sync devices

getSyncDevices

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SyncDevice> getSyncDevices(long userId,
                                                                                                             int start,
                                                                                                             int end,
                                                                                                             OrderByComparator<SyncDevice> orderByComparator)
                                                                                                      throws PortalException

Throws:

PortalException

getSyncDevicesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSyncDevicesCount()

Returns the number of sync devices.

Returns:

the number of sync devices

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SyncDevice> search(long companyId,
                                                                                                     java.lang.String keywords,
                                                                                                     int start,
                                                                                                     int end,
                                                                                                     OrderByComparator<SyncDevice> orderByComparator)

updateStatus

void updateStatus(long syncDeviceId,
                  int status)
           throws PortalException

Throws:

PortalException

updateSyncDevice

SyncDevice updateSyncDevice(long syncDeviceId,
                            java.lang.String type,
                            long buildNumber,
                            int featureSet,
                            java.lang.String hostname,
                            int status)
                     throws PortalException

Throws:

PortalException

updateSyncDevice

@Indexable(type=REINDEX)
SyncDevice updateSyncDevice(SyncDevice syncDevice)

Updates the sync device in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect SyncDeviceLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

syncDevice - the sync device

Returns:

the sync device that was updated