com.liferay.remote.app.service

Interface RemoteAppEntryLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

RemoteAppEntryLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface RemoteAppEntryLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

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

RemoteAppEntryLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
RemoteAppEntry	addCustomElementRemoteAppEntry(long userId, java.lang.String customElementCSSURLs, java.lang.String customElementHTMLElementName, java.lang.String customElementURLs, java.lang.String description, java.lang.String friendlyURLMapping, boolean instanceable, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.lang.String portletCategoryName, java.lang.String properties, java.lang.String sourceCodeURL)
RemoteAppEntry	addIFrameRemoteAppEntry(long userId, java.lang.String description, java.lang.String friendlyURLMapping, java.lang.String iFrameURL, boolean instanceable, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.lang.String portletCategoryName, java.lang.String properties, java.lang.String sourceCodeURL)
RemoteAppEntry	addRemoteAppEntry(RemoteAppEntry remoteAppEntry) Adds the remote app entry to the database.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
RemoteAppEntry	createRemoteAppEntry(long remoteAppEntryId) Creates a new remote app entry with the primary key.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
RemoteAppEntry	deleteRemoteAppEntry(long remoteAppEntryId) Deletes the remote app entry with the primary key from the database.
RemoteAppEntry	deleteRemoteAppEntry(RemoteAppEntry remoteAppEntry) Deletes the remote app entry from the database.
void	deployRemoteAppEntry(RemoteAppEntry remoteAppEntry)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
RemoteAppEntry	fetchRemoteAppEntry(long remoteAppEntryId)
RemoteAppEntry	fetchRemoteAppEntryByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the remote app entry with the matching UUID and company.
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<RemoteAppEntry>	getRemoteAppEntries(int start, int end) Returns a range of all the remote app entries.
int	getRemoteAppEntriesCount() Returns the number of remote app entries.
RemoteAppEntry	getRemoteAppEntry(long remoteAppEntryId) Returns the remote app entry with the primary key.
RemoteAppEntry	getRemoteAppEntryByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the remote app entry with the matching UUID and company.
java.util.List<RemoteAppEntry>	search(long companyId, java.lang.String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)
int	searchCount(long companyId, java.lang.String keywords)
void	undeployRemoteAppEntry(RemoteAppEntry remoteAppEntry)
RemoteAppEntry	updateCustomElementRemoteAppEntry(long remoteAppEntryId, java.lang.String customElementCSSURLs, java.lang.String customElementHTMLElementName, java.lang.String customElementURLs, java.lang.String description, java.lang.String friendlyURLMapping, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.lang.String portletCategoryName, java.lang.String properties, java.lang.String sourceCodeURL)
RemoteAppEntry	updateIFrameRemoteAppEntry(long remoteAppEntryId, java.lang.String description, java.lang.String friendlyURLMapping, java.lang.String iFrameURL, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.lang.String portletCategoryName, java.lang.String properties, java.lang.String sourceCodeURL)
RemoteAppEntry	updateRemoteAppEntry(RemoteAppEntry remoteAppEntry) Updates the remote app entry in the database or adds it if it does not yet exist.
RemoteAppEntry	updateStatus(long userId, long remoteAppEntryId, int status)

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

getBasePersistence

Method Detail

addCustomElementRemoteAppEntry

@Indexable(type=REINDEX)
RemoteAppEntry addCustomElementRemoteAppEntry(long userId,
                                                                       java.lang.String customElementCSSURLs,
                                                                       java.lang.String customElementHTMLElementName,
                                                                       java.lang.String customElementURLs,
                                                                       java.lang.String description,
                                                                       java.lang.String friendlyURLMapping,
                                                                       boolean instanceable,
                                                                       java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                                       java.lang.String portletCategoryName,
                                                                       java.lang.String properties,
                                                                       java.lang.String sourceCodeURL)
                                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addIFrameRemoteAppEntry

@Indexable(type=REINDEX)
RemoteAppEntry addIFrameRemoteAppEntry(long userId,
                                                                java.lang.String description,
                                                                java.lang.String friendlyURLMapping,
                                                                java.lang.String iFrameURL,
                                                                boolean instanceable,
                                                                java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                                java.lang.String portletCategoryName,
                                                                java.lang.String properties,
                                                                java.lang.String sourceCodeURL)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addRemoteAppEntry

@Indexable(type=REINDEX)
RemoteAppEntry addRemoteAppEntry(RemoteAppEntry remoteAppEntry)

Adds the remote app entry to the database. Also notifies the appropriate model listeners.

Important: Inspect RemoteAppEntryLocalServiceImpl 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:

remoteAppEntry - the remote app entry

Returns:

the remote app entry that was added

createPersistedModel

com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

createRemoteAppEntry

@Transactional(enabled=false)
RemoteAppEntry createRemoteAppEntry(long remoteAppEntryId)

Creates a new remote app entry with the primary key. Does not add the remote app entry to the database.

Parameters:

remoteAppEntryId - the primary key for the new remote app entry

Returns:

the new remote app entry

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteRemoteAppEntry

@Indexable(type=DELETE)
RemoteAppEntry deleteRemoteAppEntry(long remoteAppEntryId)
                                                     throws com.liferay.portal.kernel.exception.PortalException

Deletes the remote app entry with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect RemoteAppEntryLocalServiceImpl 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:

remoteAppEntryId - the primary key of the remote app entry

Returns:

the remote app entry that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a remote app entry with the primary key could not be found

deleteRemoteAppEntry

@Indexable(type=DELETE)
 @SystemEvent(type=1)
RemoteAppEntry deleteRemoteAppEntry(RemoteAppEntry remoteAppEntry)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Deletes the remote app entry from the database. Also notifies the appropriate model listeners.

Important: Inspect RemoteAppEntryLocalServiceImpl 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:

remoteAppEntry - the remote app entry

Returns:

the remote app entry that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deployRemoteAppEntry

@Clusterable
void deployRemoteAppEntry(RemoteAppEntry remoteAppEntry)

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.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.remote.app.model.impl.RemoteAppEntryModelImpl.

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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      com.liferay.portal.kernel.util.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.remote.app.model.impl.RemoteAppEntryModelImpl.

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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                          com.liferay.portal.kernel.dao.orm.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

fetchRemoteAppEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RemoteAppEntry fetchRemoteAppEntry(long remoteAppEntryId)

fetchRemoteAppEntryByUuidAndCompanyId

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

Returns the remote app entry with the matching UUID and company.

Parameters:

uuid - the remote app entry's UUID

companyId - the primary key of the company

Returns:

the matching remote app entry, or null if a matching remote app entry could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getRemoteAppEntries

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

Returns a range of all the remote app entries.

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.remote.app.model.impl.RemoteAppEntryModelImpl.

Parameters:

start - the lower bound of the range of remote app entries

end - the upper bound of the range of remote app entries (not inclusive)

Returns:

the range of remote app entries

getRemoteAppEntriesCount

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

Returns the number of remote app entries.

Returns:

the number of remote app entries

getRemoteAppEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RemoteAppEntry getRemoteAppEntry(long remoteAppEntryId)
                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Returns the remote app entry with the primary key.

Parameters:

remoteAppEntryId - the primary key of the remote app entry

Returns:

the remote app entry

Throws:

com.liferay.portal.kernel.exception.PortalException - if a remote app entry with the primary key could not be found

getRemoteAppEntryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RemoteAppEntry getRemoteAppEntryByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                      long companyId)
                                                                                                               throws com.liferay.portal.kernel.exception.PortalException

Returns the remote app entry with the matching UUID and company.

Parameters:

uuid - the remote app entry's UUID

companyId - the primary key of the company

Returns:

the matching remote app entry

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching remote app entry could not be found

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<RemoteAppEntry> search(long companyId,
                                                                                                         java.lang.String keywords,
                                                                                                         int start,
                                                                                                         int end,
                                                                                                         com.liferay.portal.kernel.search.Sort sort)
                                                                                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   java.lang.String keywords)
                                                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

undeployRemoteAppEntry

@Clusterable
void undeployRemoteAppEntry(RemoteAppEntry remoteAppEntry)

updateCustomElementRemoteAppEntry

@Indexable(type=REINDEX)
RemoteAppEntry updateCustomElementRemoteAppEntry(long remoteAppEntryId,
                                                                          java.lang.String customElementCSSURLs,
                                                                          java.lang.String customElementHTMLElementName,
                                                                          java.lang.String customElementURLs,
                                                                          java.lang.String description,
                                                                          java.lang.String friendlyURLMapping,
                                                                          java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                                          java.lang.String portletCategoryName,
                                                                          java.lang.String properties,
                                                                          java.lang.String sourceCodeURL)
                                                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateIFrameRemoteAppEntry

@Indexable(type=REINDEX)
RemoteAppEntry updateIFrameRemoteAppEntry(long remoteAppEntryId,
                                                                   java.lang.String description,
                                                                   java.lang.String friendlyURLMapping,
                                                                   java.lang.String iFrameURL,
                                                                   java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                                   java.lang.String portletCategoryName,
                                                                   java.lang.String properties,
                                                                   java.lang.String sourceCodeURL)
                                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateRemoteAppEntry

@Indexable(type=REINDEX)
RemoteAppEntry updateRemoteAppEntry(RemoteAppEntry remoteAppEntry)

Updates the remote app entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect RemoteAppEntryLocalServiceImpl 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:

remoteAppEntry - the remote app entry

Returns:

the remote app entry that was updated

updateStatus

@Indexable(type=REINDEX)
RemoteAppEntry updateStatus(long userId,
                                                     long remoteAppEntryId,
                                                     int status)
                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException