Class FragmentCompositionLocalServiceUtil
com.liferay.fragment.service.impl.FragmentCompositionLocalServiceImpl
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 FragmentComposition
addFragmentComposition
(FragmentComposition fragmentComposition) Adds the fragment composition to the database.static FragmentComposition
addFragmentComposition
(String externalReferenceCode, long userId, long groupId, long fragmentCollectionId, String fragmentCompositionKey, String name, String description, String data, long previewFileEntryId, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) static FragmentComposition
createFragmentComposition
(long fragmentCompositionId) Creates a new fragment composition with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static FragmentComposition
deleteFragmentComposition
(long fragmentCompositionId) Deletes the fragment composition with the primary key from the database.static FragmentComposition
deleteFragmentComposition
(FragmentComposition fragmentComposition) Deletes the fragment composition from the database.static FragmentComposition
deleteFragmentComposition
(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 FragmentComposition
fetchFragmentComposition
(long fragmentCompositionId) static FragmentComposition
fetchFragmentComposition
(long groupId, String fragmentCompositionKey) static FragmentComposition
fetchFragmentCompositionByExternalReferenceCode
(String externalReferenceCode, long groupId) static FragmentComposition
fetchFragmentCompositionByUuidAndGroupId
(String uuid, long groupId) Returns the fragment composition matching the UUID and group.static String
generateFragmentCompositionKey
(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 FragmentComposition
getFragmentComposition
(long fragmentCompositionId) Returns the fragment composition with the primary key.static FragmentComposition
getFragmentCompositionByExternalReferenceCode
(String externalReferenceCode, long groupId) static FragmentComposition
getFragmentCompositionByUuidAndGroupId
(String uuid, long groupId) Returns the fragment composition matching the UUID and group.static List<FragmentComposition>
getFragmentCompositions
(int start, int end) Returns a range of all the fragment compositions.static List<FragmentComposition>
getFragmentCompositions
(long fragmentCollectionId) static List<FragmentComposition>
getFragmentCompositions
(long fragmentCollectionId, int start, int end) static List<FragmentComposition>
getFragmentCompositions
(long groupId, long fragmentCollectionId, int status) static List<FragmentComposition>
getFragmentCompositions
(long groupId, long fragmentCollectionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentComposition> orderByComparator) static List<FragmentComposition>
getFragmentCompositions
(long groupId, long fragmentCollectionId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentComposition> orderByComparator) static List<FragmentComposition>
getFragmentCompositionsByUuidAndCompanyId
(String uuid, long companyId) Returns all the fragment compositions matching the UUID and company.static List<FragmentComposition>
getFragmentCompositionsByUuidAndCompanyId
(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentComposition> orderByComparator) Returns a range of fragment compositions matching the UUID and company.static int
Returns the number of fragment compositions.static int
getFragmentCompositionsCount
(long fragmentCollectionId) 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
getUniqueFragmentCompositionName
(long groupId, long fragmentCollectionId, String name) static FragmentComposition
moveFragmentComposition
(long fragmentCompositionId, long fragmentCollectionId) static FragmentComposition
updateFragmentComposition
(long fragmentCompositionId, long previewFileEntryId) static FragmentComposition
updateFragmentComposition
(long userId, long fragmentCompositionId, long fragmentCollectionId, String name, String description, String data, long previewFileEntryId, int status) static FragmentComposition
updateFragmentComposition
(long fragmentCompositionId, String name) static FragmentComposition
updateFragmentComposition
(FragmentComposition fragmentComposition) Updates the fragment composition in the database or adds it if it does not yet exist.
-
Constructor Details
-
FragmentCompositionLocalServiceUtil
public FragmentCompositionLocalServiceUtil()
-
-
Method Details
-
addFragmentComposition
Adds the fragment composition to the database. Also notifies the appropriate model listeners.Important: Inspect FragmentCompositionLocalServiceImpl 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:
fragmentComposition
- the fragment composition- Returns:
- the fragment composition that was added
-
addFragmentComposition
public static FragmentComposition addFragmentComposition(String externalReferenceCode, long userId, long groupId, long fragmentCollectionId, String fragmentCompositionKey, String name, String description, String data, long previewFileEntryId, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createFragmentComposition
Creates a new fragment composition with the primary key. Does not add the fragment composition to the database.- Parameters:
fragmentCompositionId
- the primary key for the new fragment composition- Returns:
- the new fragment composition
-
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
-
deleteFragmentComposition
public static FragmentComposition deleteFragmentComposition(FragmentComposition fragmentComposition) throws com.liferay.portal.kernel.exception.PortalException Deletes the fragment composition from the database. Also notifies the appropriate model listeners.Important: Inspect FragmentCompositionLocalServiceImpl 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:
fragmentComposition
- the fragment composition- Returns:
- the fragment composition that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteFragmentComposition
public static FragmentComposition deleteFragmentComposition(long fragmentCompositionId) throws com.liferay.portal.kernel.exception.PortalException Deletes the fragment composition with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect FragmentCompositionLocalServiceImpl 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:
fragmentCompositionId
- the primary key of the fragment composition- Returns:
- the fragment composition that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a fragment composition with the primary key could not be found
-
deleteFragmentComposition
public static FragmentComposition deleteFragmentComposition(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.FragmentCompositionModelImpl
.- 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.FragmentCompositionModelImpl
.- 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
-
fetchFragmentComposition
-
fetchFragmentComposition
public static FragmentComposition fetchFragmentComposition(long groupId, String fragmentCompositionKey) -
fetchFragmentCompositionByExternalReferenceCode
public static FragmentComposition fetchFragmentCompositionByExternalReferenceCode(String externalReferenceCode, long groupId) -
fetchFragmentCompositionByUuidAndGroupId
public static FragmentComposition fetchFragmentCompositionByUuidAndGroupId(String uuid, long groupId) Returns the fragment composition matching the UUID and group.- Parameters:
uuid
- the fragment composition's UUIDgroupId
- the primary key of the group- Returns:
- the matching fragment composition, or
null
if a matching fragment composition could not be found
-
generateFragmentCompositionKey
-
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) -
getFragmentComposition
public static FragmentComposition getFragmentComposition(long fragmentCompositionId) throws com.liferay.portal.kernel.exception.PortalException Returns the fragment composition with the primary key.- Parameters:
fragmentCompositionId
- the primary key of the fragment composition- Returns:
- the fragment composition
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a fragment composition with the primary key could not be found
-
getFragmentCompositionByExternalReferenceCode
public static FragmentComposition getFragmentCompositionByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFragmentCompositionByUuidAndGroupId
public static FragmentComposition getFragmentCompositionByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the fragment composition matching the UUID and group.- Parameters:
uuid
- the fragment composition's UUIDgroupId
- the primary key of the group- Returns:
- the matching fragment composition
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a matching fragment composition could not be found
-
getFragmentCompositions
Returns a range of all the fragment compositions.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.FragmentCompositionModelImpl
.- Parameters:
start
- the lower bound of the range of fragment compositionsend
- the upper bound of the range of fragment compositions (not inclusive)- Returns:
- the range of fragment compositions
-
getFragmentCompositions
-
getFragmentCompositions
public static List<FragmentComposition> getFragmentCompositions(long fragmentCollectionId, int start, int end) -
getFragmentCompositions
public static List<FragmentComposition> getFragmentCompositions(long groupId, long fragmentCollectionId, int status) -
getFragmentCompositions
public static List<FragmentComposition> getFragmentCompositions(long groupId, long fragmentCollectionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentComposition> orderByComparator) -
getFragmentCompositions
public static List<FragmentComposition> getFragmentCompositions(long groupId, long fragmentCollectionId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentComposition> orderByComparator) -
getFragmentCompositionsByUuidAndCompanyId
public static List<FragmentComposition> getFragmentCompositionsByUuidAndCompanyId(String uuid, long companyId) Returns all the fragment compositions matching the UUID and company.- Parameters:
uuid
- the UUID of the fragment compositionscompanyId
- the primary key of the company- Returns:
- the matching fragment compositions, or an empty list if no matches were found
-
getFragmentCompositionsByUuidAndCompanyId
public static List<FragmentComposition> getFragmentCompositionsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentComposition> orderByComparator) Returns a range of fragment compositions matching the UUID and company.- Parameters:
uuid
- the UUID of the fragment compositionscompanyId
- the primary key of the companystart
- the lower bound of the range of fragment compositionsend
- the upper bound of the range of fragment compositions (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching fragment compositions, or an empty list if no matches were found
-
getFragmentCompositionsCount
public static int getFragmentCompositionsCount()Returns the number of fragment compositions.- Returns:
- the number of fragment compositions
-
getFragmentCompositionsCount
public static int getFragmentCompositionsCount(long fragmentCollectionId) -
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
-
getUniqueFragmentCompositionName
-
moveFragmentComposition
public static FragmentComposition moveFragmentComposition(long fragmentCompositionId, long fragmentCollectionId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateFragmentComposition
public static FragmentComposition updateFragmentComposition(FragmentComposition fragmentComposition) Updates the fragment composition in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect FragmentCompositionLocalServiceImpl 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:
fragmentComposition
- the fragment composition- Returns:
- the fragment composition that was updated
-
updateFragmentComposition
public static FragmentComposition updateFragmentComposition(long fragmentCompositionId, long previewFileEntryId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateFragmentComposition
public static FragmentComposition updateFragmentComposition(long userId, long fragmentCompositionId, long fragmentCollectionId, String name, String description, String data, long previewFileEntryId, int status) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateFragmentComposition
public static FragmentComposition updateFragmentComposition(long fragmentCompositionId, String name) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-