Interface ObjectDefinitionSettingLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
ObjectDefinitionSettingLocalServiceWrapper

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface ObjectDefinitionSettingLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for ObjectDefinitionSetting. 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:
  • Method Details

    • addObjectDefinitionSetting

      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

      @Indexable(type=REINDEX) 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

      @Transactional(enabled=false) 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

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectDefinitionSetting

      @Indexable(type=DELETE) 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

      @Indexable(type=DELETE) 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

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectDefinitionSetting fetchObjectDefinitionSetting(long objectDefinitionSettingId)
    • fetchObjectDefinitionSetting

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectDefinitionSetting fetchObjectDefinitionSetting(long objectDefinitionId, String name)
    • fetchObjectDefinitionSettingByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getObjectDefinitionSetting

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectDefinitionSetting getObjectDefinitionSetting(long objectDefinitionId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectDefinitionSettingByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectDefinitionSetting> getObjectDefinitionSettings(long objectDefinitionId)
    • getObjectDefinitionSettingsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectDefinitionSettingsCount()
      Returns the number of object definition settings.
      Returns:
      the number of object definition settings
    • getObjectDefinitionSettingsMap

      @Transactional(propagation=SUPPORTS, readOnly=true) Map<Long,ObjectDefinitionSetting> getObjectDefinitionSettingsMap(long companyId, String name)
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateObjectDefinitionSetting

      @Indexable(type=REINDEX) 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