Interface FragmentCollectionLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService
,com.liferay.portal.kernel.service.change.tracking.CTService<FragmentCollection>
,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
FragmentCollectionLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddFragmentCollection
(FragmentCollection fragmentCollection) Adds the fragment collection to the database.addFragmentCollection
(String externalReferenceCode, long userId, long groupId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) addFragmentCollection
(String externalReferenceCode, long userId, long groupId, String fragmentCollectionKey, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) createFragmentCollection
(long fragmentCollectionId) Creates a new fragment collection with the primary key.com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) deleteFragmentCollection
(long fragmentCollectionId) Deletes the fragment collection with the primary key from the database.deleteFragmentCollection
(FragmentCollection fragmentCollection) Deletes the fragment collection from the database.deleteFragmentCollection
(String externalReferenceCode, long groupId) 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) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery
<T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> 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> 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.fetchFragmentCollection
(long fragmentCollectionId) fetchFragmentCollection
(long groupId, String fragmentCollectionKey) fetchFragmentCollectionByExternalReferenceCode
(String externalReferenceCode, long groupId) fetchFragmentCollectionByUuidAndGroupId
(String uuid, long groupId) Returns the fragment collection matching the UUID and group.generateFragmentCollectionKey
(long groupId, String name) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<FragmentCollection>
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) getFragmentCollection
(long fragmentCollectionId) Returns the fragment collection with the primary key.getFragmentCollectionByExternalReferenceCode
(String externalReferenceCode, long groupId) getFragmentCollectionByUuidAndGroupId
(String uuid, long groupId) Returns the fragment collection matching the UUID and group.getFragmentCollections
(int start, int end) Returns a range of all the fragment collections.getFragmentCollections
(long groupId, int start, int end) getFragmentCollections
(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator) getFragmentCollections
(long groupId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator) getFragmentCollectionsByUuidAndCompanyId
(String uuid, long companyId) Returns all the fragment collections matching the UUID and company.getFragmentCollectionsByUuidAndCompanyId
(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
Returns the number of fragment collections.com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) String[]
getTempFileNames
(long userId, long groupId, String folderName) getUniqueFragmentCollectionName
(long groupId, String name) updateFragmentCollection
(long fragmentCollectionId, String name, String description) updateFragmentCollection
(FragmentCollection fragmentCollection) Updates the fragment collection in the database or adds it if it does not yet exist.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<FragmentCollection>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addFragmentCollection
@Indexable(type=REINDEX) FragmentCollection addFragmentCollection(FragmentCollection fragmentCollection) Adds the fragment collection to the database. Also notifies the appropriate model listeners.Important: Inspect FragmentCollectionLocalServiceImpl 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:
fragmentCollection
- the fragment collection- Returns:
- the fragment collection that was added
-
addFragmentCollection
FragmentCollection addFragmentCollection(String externalReferenceCode, long userId, long groupId, String name, 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(String externalReferenceCode, long userId, long groupId, String fragmentCollectionKey, String name, 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(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModel
in interfacecom.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.Important: Inspect FragmentCollectionLocalServiceImpl 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:
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.Important: Inspect FragmentCollectionLocalServiceImpl 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:
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
-
deleteFragmentCollection
FragmentCollection deleteFragmentCollection(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
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 interfacecom.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) - Specified by:
dslQuery
in interfacecom.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 interfacecom.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> 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> 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.fragment.model.impl.FragmentCollectionModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.fragment.model.impl.FragmentCollectionModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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 queryprojection
- 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, String fragmentCollectionKey) -
fetchFragmentCollectionByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) FragmentCollection fetchFragmentCollectionByExternalReferenceCode(String externalReferenceCode, long groupId) -
fetchFragmentCollectionByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) FragmentCollection fetchFragmentCollectionByUuidAndGroupId(String uuid, long groupId) Returns the fragment collection matching the UUID and group.- Parameters:
uuid
- the fragment collection's UUIDgroupId
- the primary key of the group- Returns:
- the matching fragment collection, or
null
if a matching fragment collection could not be found
-
generateFragmentCollectionKey
-
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
-
getFragmentCollectionByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) FragmentCollection getFragmentCollectionByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFragmentCollectionByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) FragmentCollection getFragmentCollectionByUuidAndGroupId(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 UUIDgroupId
- 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) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.fragment.model.impl.FragmentCollectionModelImpl
.- Parameters:
start
- the lower bound of the range of fragment collectionsend
- the upper bound of the range of fragment collections (not inclusive)- Returns:
- the range of fragment collections
-
getFragmentCollections
@Transactional(propagation=SUPPORTS, readOnly=true) List<FragmentCollection> getFragmentCollections(long groupId, int start, int end) -
getFragmentCollections
@Transactional(propagation=SUPPORTS, readOnly=true) List<FragmentCollection> getFragmentCollections(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator) -
getFragmentCollections
@Transactional(propagation=SUPPORTS, readOnly=true) List<FragmentCollection> getFragmentCollections(long groupId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator) -
getFragmentCollectionsByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) List<FragmentCollection> getFragmentCollectionsByUuidAndCompanyId(String uuid, long companyId) Returns all the fragment collections matching the UUID and company.- Parameters:
uuid
- the UUID of the fragment collectionscompanyId
- 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) List<FragmentCollection> getFragmentCollectionsByUuidAndCompanyId(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 collectionscompanyId
- the primary key of the companystart
- the lower bound of the range of fragment collectionsend
- the upper bound of the range of fragment collections (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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
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(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getTempFileNames
@Transactional(propagation=SUPPORTS, readOnly=true) String[] getTempFileNames(long userId, long groupId, String folderName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getUniqueFragmentCollectionName
-
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.Important: Inspect FragmentCollectionLocalServiceImpl 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:
fragmentCollection
- the fragment collection- Returns:
- the fragment collection that was updated
-
updateFragmentCollection
FragmentCollection updateFragmentCollection(long fragmentCollectionId, String name, String description) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCTPersistence
@Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<FragmentCollection> getCTPersistence()- Specified by:
getCTPersistence
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<FragmentCollection>
-
getModelClass
- Specified by:
getModelClass
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<FragmentCollection>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<FragmentCollection>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<FragmentCollection>
- Throws:
E extends Throwable
-