Class ObjectFieldSettingLocalServiceUtil

java.lang.Object
com.liferay.object.service.ObjectFieldSettingLocalServiceUtil

public class ObjectFieldSettingLocalServiceUtil extends Object
Provides the local service utility for ObjectFieldSetting. This utility wraps com.liferay.object.service.impl.ObjectFieldSettingLocalServiceImpl 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 Details

    • ObjectFieldSettingLocalServiceUtil

      public ObjectFieldSettingLocalServiceUtil()
  • Method Details

    • addObjectFieldSetting

      public static ObjectFieldSetting addObjectFieldSetting(long userId, long objectFieldId, String name, String value) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addObjectFieldSetting

      public static ObjectFieldSetting addObjectFieldSetting(ObjectFieldSetting objectFieldSetting)
      Adds the object field setting to the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectFieldSettingLocalServiceImpl 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:
      objectFieldSetting - the object field setting
      Returns:
      the object field setting that was added
    • createObjectFieldSetting

      public static ObjectFieldSetting createObjectFieldSetting(long objectFieldSettingId)
      Creates a new object field setting with the primary key. Does not add the object field setting to the database.
      Parameters:
      objectFieldSettingId - the primary key for the new object field setting
      Returns:
      the new object field setting
    • 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
    • deleteObjectFieldObjectFieldSetting

      public static void deleteObjectFieldObjectFieldSetting(ObjectField objectField) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectFieldSetting

      public static ObjectFieldSetting deleteObjectFieldSetting(long objectFieldSettingId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object field setting with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectFieldSettingLocalServiceImpl 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:
      objectFieldSettingId - the primary key of the object field setting
      Returns:
      the object field setting that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object field setting with the primary key could not be found
    • deleteObjectFieldSetting

      public static ObjectFieldSetting deleteObjectFieldSetting(ObjectFieldSetting objectFieldSetting)
      Deletes the object field setting from the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectFieldSettingLocalServiceImpl 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:
      objectFieldSetting - the object field setting
      Returns:
      the object field setting that was removed
    • 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

      public 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.
      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 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.object.model.impl.ObjectFieldSettingModelImpl.

      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

      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 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.object.model.impl.ObjectFieldSettingModelImpl.

      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

      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 query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchObjectFieldSetting

      public static ObjectFieldSetting fetchObjectFieldSetting(long objectFieldSettingId)
    • fetchObjectFieldSetting

      public static ObjectFieldSetting fetchObjectFieldSetting(long objectFieldId, String name)
    • fetchObjectFieldSettingByUuidAndCompanyId

      public static ObjectFieldSetting fetchObjectFieldSettingByUuidAndCompanyId(String uuid, long companyId)
      Returns the object field setting with the matching UUID and company.
      Parameters:
      uuid - the object field setting's UUID
      companyId - the primary key of the company
      Returns:
      the matching object field setting, or null if a matching object field setting could not be found
    • 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)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getObjectFieldObjectFieldSettings

      public static List<ObjectFieldSetting> getObjectFieldObjectFieldSettings(long objectFieldId)
    • getObjectFieldSetting

      public static ObjectFieldSetting getObjectFieldSetting(long objectFieldSettingId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object field setting with the primary key.
      Parameters:
      objectFieldSettingId - the primary key of the object field setting
      Returns:
      the object field setting
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object field setting with the primary key could not be found
    • getObjectFieldSettingByUuidAndCompanyId

      public static ObjectFieldSetting getObjectFieldSettingByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object field setting with the matching UUID and company.
      Parameters:
      uuid - the object field setting's UUID
      companyId - the primary key of the company
      Returns:
      the matching object field setting
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching object field setting could not be found
    • getObjectFieldSettings

      public static List<ObjectFieldSetting> getObjectFieldSettings(int start, int end)
      Returns a range of all the object field settings.

      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.object.model.impl.ObjectFieldSettingModelImpl.

      Parameters:
      start - the lower bound of the range of object field settings
      end - the upper bound of the range of object field settings (not inclusive)
      Returns:
      the range of object field settings
    • getObjectFieldSettingsCount

      public static int getObjectFieldSettingsCount()
      Returns the number of object field settings.
      Returns:
      the number of object field settings
    • getOSGiServiceIdentifier

      public static String 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
    • updateObjectFieldSetting

      public static ObjectFieldSetting updateObjectFieldSetting(long objectFieldSettingId, String value) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateObjectFieldSetting

      public static ObjectFieldSetting updateObjectFieldSetting(ObjectFieldSetting objectFieldSetting)
      Updates the object field setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect ObjectFieldSettingLocalServiceImpl 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:
      objectFieldSetting - the object field setting
      Returns:
      the object field setting that was updated
    • getService

      public static ObjectFieldSettingLocalService getService()