com.liferay.fragment.service

Interface FragmentCollectionLocalService

All Superinterfaces:

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

All Known Implementing Classes:

FragmentCollectionLocalServiceWrapper

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

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

FragmentCollectionLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
FragmentCollection	addFragmentCollection(FragmentCollection fragmentCollection) Adds the fragment collection to the database.
FragmentCollection	addFragmentCollection(long userId, long groupId, java.lang.String name, java.lang.String description, com.liferay.portal.kernel.service.ServiceContext serviceContext)
FragmentCollection	addFragmentCollection(long userId, long groupId, java.lang.String fragmentCollectionKey, java.lang.String name, java.lang.String description, com.liferay.portal.kernel.service.ServiceContext serviceContext)
FragmentCollection	createFragmentCollection(long fragmentCollectionId) Creates a new fragment collection with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
FragmentCollection	deleteFragmentCollection(FragmentCollection fragmentCollection) Deletes the fragment collection from the database.
FragmentCollection	deleteFragmentCollection(long fragmentCollectionId) Deletes the fragment collection with the primary key from the database.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
<T> T	dslQuery(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.
FragmentCollection	fetchFragmentCollection(long fragmentCollectionId)
FragmentCollection	fetchFragmentCollection(long groupId, java.lang.String fragmentCollectionKey)
FragmentCollection	fetchFragmentCollectionByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the fragment collection matching the UUID and group.
java.lang.String	generateFragmentCollectionKey(long groupId, java.lang.String name)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
FragmentCollection	getFragmentCollection(long fragmentCollectionId) Returns the fragment collection with the primary key.
FragmentCollection	getFragmentCollectionByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the fragment collection matching the UUID and group.
java.util.List<FragmentCollection>	getFragmentCollections(int start, int end) Returns a range of all the fragment collections.
java.util.List<FragmentCollection>	getFragmentCollections(long groupId, int start, int end)
java.util.List<FragmentCollection>	getFragmentCollections(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator)
java.util.List<FragmentCollection>	getFragmentCollections(long groupId, java.lang.String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator)
java.util.List<FragmentCollection>	getFragmentCollectionsByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the fragment collections matching the UUID and company.
java.util.List<FragmentCollection>	getFragmentCollectionsByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator) Returns a range of fragment collections matching the UUID and company.
int	getFragmentCollectionsCount() Returns the number of fragment collections.
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.lang.String[]	getTempFileNames(long userId, long groupId, java.lang.String folderName)
FragmentCollection	updateFragmentCollection(FragmentCollection fragmentCollection) Updates the fragment collection in the database or adds it if it does not yet exist.
FragmentCollection	updateFragmentCollection(long fragmentCollectionId, java.lang.String name, java.lang.String description)

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

getBasePersistence

Method Detail

addFragmentCollection

@Indexable(type=REINDEX)
FragmentCollection addFragmentCollection(FragmentCollection fragmentCollection)

Adds the fragment collection to the database. Also notifies the appropriate model listeners.

Parameters:

fragmentCollection - the fragment collection

Returns:

the fragment collection that was added

addFragmentCollection

FragmentCollection addFragmentCollection(long userId,
                                         long groupId,
                                         java.lang.String name,
                                         java.lang.String description,
                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addFragmentCollection

FragmentCollection addFragmentCollection(long userId,
                                         long groupId,
                                         java.lang.String fragmentCollectionKey,
                                         java.lang.String name,
                                         java.lang.String description,
                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createFragmentCollection

@Transactional(enabled=false)
FragmentCollection createFragmentCollection(long fragmentCollectionId)

Creates a new fragment collection with the primary key. Does not add the fragment collection to the database.

Parameters:

fragmentCollectionId - the primary key for the new fragment collection

Returns:

the new fragment collection

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

deleteFragmentCollection

@Indexable(type=DELETE)
 @SystemEvent(type=1)
FragmentCollection deleteFragmentCollection(FragmentCollection fragmentCollection)
                                                                                   throws com.liferay.portal.kernel.exception.PortalException

Deletes the fragment collection from the database. Also notifies the appropriate model listeners.

Parameters:

fragmentCollection - the fragment collection

Returns:

the fragment collection that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteFragmentCollection

@Indexable(type=DELETE)
FragmentCollection deleteFragmentCollection(long fragmentCollectionId)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Deletes the fragment collection with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

fragmentCollectionId - the primary key of the fragment collection

Returns:

the fragment collection that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a fragment collection with the primary key could not be found

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

dslQuery

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

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.fragment.model.impl.FragmentCollectionModelImpl.

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.fragment.model.impl.FragmentCollectionModelImpl.

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

fetchFragmentCollection

@Transactional(propagation=SUPPORTS,
               readOnly=true)
FragmentCollection fetchFragmentCollection(long fragmentCollectionId)

fetchFragmentCollection

@Transactional(propagation=SUPPORTS,
               readOnly=true)
FragmentCollection fetchFragmentCollection(long groupId,
                                                                                                              java.lang.String fragmentCollectionKey)

fetchFragmentCollectionByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
FragmentCollection fetchFragmentCollectionByUuidAndGroupId(java.lang.String uuid,
                                                                                                                              long groupId)

Returns the fragment collection matching the UUID and group.

Parameters:

uuid - the fragment collection's UUID

groupId - the primary key of the group

Returns:

the matching fragment collection, or null if a matching fragment collection could not be found

generateFragmentCollectionKey

java.lang.String generateFragmentCollectionKey(long groupId,
                                               java.lang.String name)

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)

getFragmentCollection

@Transactional(propagation=SUPPORTS,
               readOnly=true)
FragmentCollection getFragmentCollection(long fragmentCollectionId)
                                                                                                     throws com.liferay.portal.kernel.exception.PortalException

Returns the fragment collection with the primary key.

Parameters:

fragmentCollectionId - the primary key of the fragment collection

Returns:

the fragment collection

Throws:

com.liferay.portal.kernel.exception.PortalException - if a fragment collection with the primary key could not be found

getFragmentCollectionByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
FragmentCollection getFragmentCollectionByUuidAndGroupId(java.lang.String uuid,
                                                                                                                            long groupId)
                                                                                                                     throws com.liferay.portal.kernel.exception.PortalException

Returns the fragment collection matching the UUID and group.

Parameters:

uuid - the fragment collection's UUID

groupId - the primary key of the group

Returns:

the matching fragment collection

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching fragment collection could not be found

getFragmentCollections

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

Returns a range of all the fragment collections.

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.fragment.model.impl.FragmentCollectionModelImpl.

Parameters:

start - the lower bound of the range of fragment collections

end - the upper bound of the range of fragment collections (not inclusive)

Returns:

the range of fragment collections

getFragmentCollections

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<FragmentCollection> getFragmentCollections(long groupId,
                                                                                                                             int start,
                                                                                                                             int end)

getFragmentCollections

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<FragmentCollection> getFragmentCollections(long groupId,
                                                                                                                             int start,
                                                                                                                             int end,
                                                                                                                             com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator)

getFragmentCollections

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<FragmentCollection> getFragmentCollections(long groupId,
                                                                                                                             java.lang.String name,
                                                                                                                             int start,
                                                                                                                             int end,
                                                                                                                             com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator)

getFragmentCollectionsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<FragmentCollection> getFragmentCollectionsByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                               long companyId)

Returns all the fragment collections matching the UUID and company.

Parameters:

uuid - the UUID of the fragment collections

companyId - the primary key of the company

Returns:

the matching fragment collections, or an empty list if no matches were found

getFragmentCollectionsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<FragmentCollection> getFragmentCollectionsByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                               long companyId,
                                                                                                                                               int start,
                                                                                                                                               int end,
                                                                                                                                               com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator)

Returns a range of fragment collections matching the UUID and company.

Parameters:

uuid - the UUID of the fragment collections

companyId - the primary key of the company

start - the lower bound of the range of fragment collections

end - the upper bound of the range of fragment collections (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching fragment collections, or an empty list if no matches were found

getFragmentCollectionsCount

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

Returns the number of fragment collections.

Returns:

the number of fragment collections

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

getTempFileNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String[] getTempFileNames(long userId,
                                                                                                       long groupId,
                                                                                                       java.lang.String folderName)
                                                                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateFragmentCollection

@Indexable(type=REINDEX)
FragmentCollection updateFragmentCollection(FragmentCollection fragmentCollection)

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

Parameters:

fragmentCollection - the fragment collection

Returns:

the fragment collection that was updated

updateFragmentCollection

FragmentCollection updateFragmentCollection(long fragmentCollectionId,
                                            java.lang.String name,
                                            java.lang.String description)
                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException