Class ObjectDefinitionSettingLocalServiceUtil

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

public class ObjectDefinitionSettingLocalServiceUtil extends Object
Provides the local service utility for ObjectDefinitionSetting. This utility wraps com.liferay.object.service.impl.ObjectDefinitionSettingLocalServiceImpl 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

    • ObjectDefinitionSettingLocalServiceUtil

      public ObjectDefinitionSettingLocalServiceUtil()
  • Method Details

    • addObjectDefinitionSetting

      public static ObjectDefinitionSetting addObjectDefinitionSetting(long userId, long objectDefinitionId, String name, String value) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addObjectDefinitionSetting

      public static ObjectDefinitionSetting addObjectDefinitionSetting(ObjectDefinitionSetting objectDefinitionSetting)
      Adds the object definition setting to the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectDefinitionSettingLocalServiceImpl 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:
      objectDefinitionSetting - the object definition setting
      Returns:
      the object definition setting that was added
    • createObjectDefinitionSetting

      public static ObjectDefinitionSetting createObjectDefinitionSetting(long objectDefinitionSettingId)
      Creates a new object definition setting with the primary key. Does not add the object definition setting to the database.
      Parameters:
      objectDefinitionSettingId - the primary key for the new object definition setting
      Returns:
      the new object definition 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
    • deleteObjectDefinitionSetting

      public static ObjectDefinitionSetting deleteObjectDefinitionSetting(long objectDefinitionSettingId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object definition setting with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static ObjectDefinitionSetting deleteObjectDefinitionSetting(ObjectDefinitionSetting objectDefinitionSetting)
      Deletes the object definition setting from the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectDefinitionSettingLocalServiceImpl 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:
      objectDefinitionSetting - the object definition setting
      Returns:
      the object definition 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.ObjectDefinitionSettingModelImpl.

      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.ObjectDefinitionSettingModelImpl.

      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
    • fetchObjectDefinitionSetting

      public static ObjectDefinitionSetting fetchObjectDefinitionSetting(long objectDefinitionSettingId)
    • fetchObjectDefinitionSetting

      public static ObjectDefinitionSetting fetchObjectDefinitionSetting(long objectDefinitionId, String name)
    • fetchObjectDefinitionSettingByUuidAndCompanyId

      public static ObjectDefinitionSetting fetchObjectDefinitionSettingByUuidAndCompanyId(String uuid, long companyId)
      Returns the object definition setting with the matching UUID and company.
      Parameters:
      uuid - the object definition setting's UUID
      companyId - the primary key of the company
      Returns:
      the matching object definition setting, or null if a matching object definition 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()
    • getObjectDefinitionSetting

      public static ObjectDefinitionSetting getObjectDefinitionSetting(long objectDefinitionSettingId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object definition setting with the primary key.
      Parameters:
      objectDefinitionSettingId - the primary key of the object definition setting
      Returns:
      the object definition setting
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object definition setting with the primary key could not be found
    • getObjectDefinitionSetting

      public static ObjectDefinitionSetting getObjectDefinitionSetting(long objectDefinitionId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectDefinitionSettingByUuidAndCompanyId

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

      public static List<ObjectDefinitionSetting> getObjectDefinitionSettings(int start, int end)
      Returns a range of all the object definition 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.ObjectDefinitionSettingModelImpl.

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

      public static List<ObjectDefinitionSetting> getObjectDefinitionSettings(long objectDefinitionId)
    • getObjectDefinitionSettingsCount

      public static int getObjectDefinitionSettingsCount()
      Returns the number of object definition settings.
      Returns:
      the number of object definition 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
    • updateObjectDefinitionSetting

      public static ObjectDefinitionSetting updateObjectDefinitionSetting(ObjectDefinitionSetting objectDefinitionSetting)
      Updates the object definition setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect ObjectDefinitionSettingLocalServiceImpl 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:
      objectDefinitionSetting - the object definition setting
      Returns:
      the object definition setting that was updated
    • getService

      public static ObjectDefinitionSettingLocalService getService()