Class FragmentCollectionLocalServiceUtil
com.liferay.fragment.service.impl.FragmentCollectionLocalServiceImpl
and
is an access point for service operations in application layer code running
on the local server. 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:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic FragmentCollection
addFragmentCollection
(FragmentCollection fragmentCollection) Adds the fragment collection to the database.static FragmentCollection
addFragmentCollection
(String externalReferenceCode, long userId, long groupId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) static FragmentCollection
addFragmentCollection
(String externalReferenceCode, long userId, long groupId, String fragmentCollectionKey, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) static FragmentCollection
createFragmentCollection
(long fragmentCollectionId) Creates a new fragment collection with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static FragmentCollection
deleteFragmentCollection
(long fragmentCollectionId) Deletes the fragment collection with the primary key from the database.static FragmentCollection
deleteFragmentCollection
(FragmentCollection fragmentCollection) Deletes the fragment collection from the database.static FragmentCollection
deleteFragmentCollection
(String externalReferenceCode, long groupId) static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static 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.static FragmentCollection
fetchFragmentCollection
(long fragmentCollectionId) static FragmentCollection
fetchFragmentCollection
(long groupId, String fragmentCollectionKey) static FragmentCollection
fetchFragmentCollectionByExternalReferenceCode
(String externalReferenceCode, long groupId) static FragmentCollection
fetchFragmentCollectionByUuidAndGroupId
(String uuid, long groupId) Returns the fragment collection matching the UUID and group.static String
generateFragmentCollectionKey
(long groupId, String name) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static FragmentCollection
getFragmentCollection
(long fragmentCollectionId) Returns the fragment collection with the primary key.static FragmentCollection
getFragmentCollectionByExternalReferenceCode
(String externalReferenceCode, long groupId) static FragmentCollection
getFragmentCollectionByUuidAndGroupId
(String uuid, long groupId) Returns the fragment collection matching the UUID and group.static List<FragmentCollection>
getFragmentCollections
(int start, int end) Returns a range of all the fragment collections.static List<FragmentCollection>
getFragmentCollections
(long groupId, int start, int end) static List<FragmentCollection>
getFragmentCollections
(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator) static List<FragmentCollection>
getFragmentCollections
(long groupId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator) static List<FragmentCollection>
getFragmentCollectionsByUuidAndCompanyId
(String uuid, long companyId) Returns all the fragment collections matching the UUID and company.static 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.static int
Returns the number of fragment collections.static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static String[]
getTempFileNames
(long userId, long groupId, String folderName) static String
getUniqueFragmentCollectionName
(long groupId, String name) static FragmentCollection
updateFragmentCollection
(long fragmentCollectionId, String name, String description) static FragmentCollection
updateFragmentCollection
(FragmentCollection fragmentCollection) Updates the fragment collection in the database or adds it if it does not yet exist.
-
Constructor Details
-
FragmentCollectionLocalServiceUtil
public FragmentCollectionLocalServiceUtil()
-
-
Method Details
-
addFragmentCollection
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
public static 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
public static 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
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
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteFragmentCollection
public static 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
public static 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
public static FragmentCollection deleteFragmentCollection(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.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
public static <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
public static <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
public static 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
public static 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
-
fetchFragmentCollection
public static FragmentCollection fetchFragmentCollection(long groupId, String fragmentCollectionKey) -
fetchFragmentCollectionByExternalReferenceCode
public static FragmentCollection fetchFragmentCollectionByExternalReferenceCode(String externalReferenceCode, long groupId) -
fetchFragmentCollectionByUuidAndGroupId
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
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getFragmentCollection
public static 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
public static FragmentCollection getFragmentCollectionByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFragmentCollectionByUuidAndGroupId
public static 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
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
-
getFragmentCollections
public static List<FragmentCollection> getFragmentCollections(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator) -
getFragmentCollections
public static List<FragmentCollection> getFragmentCollections(long groupId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentCollection> orderByComparator) -
getFragmentCollectionsByUuidAndCompanyId
public static 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
public static 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
public static int getFragmentCollectionsCount()Returns the number of fragment collections.- Returns:
- the number of fragment collections
-
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getTempFileNames
public static String[] getTempFileNames(long userId, long groupId, String folderName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getUniqueFragmentCollectionName
-
updateFragmentCollection
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
public static FragmentCollection updateFragmentCollection(long fragmentCollectionId, String name, String description) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-