Class ObjectLayoutLocalServiceUtil
com.liferay.object.service.impl.ObjectLayoutLocalServiceImpl
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 ObjectLayout
addObjectLayout
(long userId, long objectDefinitionId, boolean defaultObjectLayout, Map<Locale, String> nameMap, List<ObjectLayoutTab> objectLayoutTabs) static ObjectLayout
addObjectLayout
(ObjectLayout objectLayout) Adds the object layout to the database.static ObjectLayout
createObjectLayout
(long objectLayoutId) Creates a new object layout with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static ObjectLayout
deleteObjectLayout
(long objectLayoutId) Deletes the object layout with the primary key from the database.static ObjectLayout
deleteObjectLayout
(ObjectLayout objectLayout) Deletes the object layout from the database.static void
deleteObjectLayouts
(long objectDefinitionId) 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 ObjectLayout
fetchDefaultObjectLayout
(long objectDefinitionId) static ObjectLayout
fetchObjectLayout
(long objectLayoutId) static ObjectLayout
fetchObjectLayoutByUuidAndCompanyId
(String uuid, long companyId) Returns the object layout with the matching UUID and company.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static ObjectLayout
getDefaultObjectLayout
(long objectDefinitionId) static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static ObjectLayout
getObjectLayout
(long objectLayoutId) Returns the object layout with the primary key.static ObjectLayout
getObjectLayoutByUuidAndCompanyId
(String uuid, long companyId) Returns the object layout with the matching UUID and company.static List<ObjectLayout>
getObjectLayouts
(int start, int end) Returns a range of all the object layouts.static List<ObjectLayout>
getObjectLayouts
(long objectDefinitionId) static List<ObjectLayout>
getObjectLayouts
(long objectDefinitionId, int start, int end) static int
Returns the number of object layouts.static int
getObjectLayoutsCount
(long objectDefinitionId) static Map<Long,
List<ObjectLayout>> getObjectLayoutsMap
(long companyId) static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static ObjectLayoutLocalService
static ObjectLayout
updateObjectLayout
(long objectLayoutId, boolean defaultObjectLayout, Map<Locale, String> nameMap, List<ObjectLayoutTab> objectLayoutTabs) static ObjectLayout
updateObjectLayout
(ObjectLayout objectLayout) Updates the object layout in the database or adds it if it does not yet exist.
-
Constructor Details
-
ObjectLayoutLocalServiceUtil
public ObjectLayoutLocalServiceUtil()
-
-
Method Details
-
addObjectLayout
public static ObjectLayout addObjectLayout(long userId, long objectDefinitionId, boolean defaultObjectLayout, Map<Locale, String> nameMap, List<ObjectLayoutTab> objectLayoutTabs) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addObjectLayout
Adds the object layout to the database. Also notifies the appropriate model listeners.Important: Inspect ObjectLayoutLocalServiceImpl 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:
objectLayout
- the object layout- Returns:
- the object layout that was added
-
createObjectLayout
Creates a new object layout with the primary key. Does not add the object layout to the database.- Parameters:
objectLayoutId
- the primary key for the new object layout- Returns:
- the new object layout
-
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
-
deleteObjectLayout
public static ObjectLayout deleteObjectLayout(long objectLayoutId) throws com.liferay.portal.kernel.exception.PortalException Deletes the object layout with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect ObjectLayoutLocalServiceImpl 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:
objectLayoutId
- the primary key of the object layout- Returns:
- the object layout that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a object layout with the primary key could not be found
-
deleteObjectLayout
public static ObjectLayout deleteObjectLayout(ObjectLayout objectLayout) throws com.liferay.portal.kernel.exception.PortalException Deletes the object layout from the database. Also notifies the appropriate model listeners.Important: Inspect ObjectLayoutLocalServiceImpl 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:
objectLayout
- the object layout- Returns:
- the object layout that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteObjectLayouts
public static void deleteObjectLayouts(long objectDefinitionId) 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.object.model.impl.ObjectLayoutModelImpl
.- 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.object.model.impl.ObjectLayoutModelImpl
.- 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
-
fetchDefaultObjectLayout
-
fetchObjectLayout
-
fetchObjectLayoutByUuidAndCompanyId
Returns the object layout with the matching UUID and company.- Parameters:
uuid
- the object layout's UUIDcompanyId
- the primary key of the company- Returns:
- the matching object layout, or
null
if a matching object layout could not be found
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getDefaultObjectLayout
public static ObjectLayout getDefaultObjectLayout(long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getObjectLayout
public static ObjectLayout getObjectLayout(long objectLayoutId) throws com.liferay.portal.kernel.exception.PortalException Returns the object layout with the primary key.- Parameters:
objectLayoutId
- the primary key of the object layout- Returns:
- the object layout
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a object layout with the primary key could not be found
-
getObjectLayoutByUuidAndCompanyId
public static ObjectLayout getObjectLayoutByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException Returns the object layout with the matching UUID and company.- Parameters:
uuid
- the object layout's UUIDcompanyId
- the primary key of the company- Returns:
- the matching object layout
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a matching object layout could not be found
-
getObjectLayouts
Returns a range of all the object layouts.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.object.model.impl.ObjectLayoutModelImpl
.- Parameters:
start
- the lower bound of the range of object layoutsend
- the upper bound of the range of object layouts (not inclusive)- Returns:
- the range of object layouts
-
getObjectLayouts
-
getObjectLayouts
-
getObjectLayoutsCount
public static int getObjectLayoutsCount()Returns the number of object layouts.- Returns:
- the number of object layouts
-
getObjectLayoutsCount
public static int getObjectLayoutsCount(long objectDefinitionId) -
getObjectLayoutsMap
-
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
-
updateObjectLayout
public static ObjectLayout updateObjectLayout(long objectLayoutId, boolean defaultObjectLayout, Map<Locale, String> nameMap, List<ObjectLayoutTab> objectLayoutTabs) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateObjectLayout
Updates the object layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect ObjectLayoutLocalServiceImpl 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:
objectLayout
- the object layout- Returns:
- the object layout that was updated
-
getService
-