Interface ObjectFieldSettingLocalService

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

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

    • addObjectFieldSetting

      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

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

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

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

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

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

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

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

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

      @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
    • fetchObjectFieldSetting

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectFieldSetting fetchObjectFieldSetting(long objectFieldSettingId)
    • fetchObjectFieldSetting

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectFieldSetting fetchObjectFieldSetting(long objectFieldId, String name)
    • fetchObjectFieldSettingByUuidAndCompanyId

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

      @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()
    • getObjectFieldObjectFieldSettings

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectFieldSetting> getObjectFieldObjectFieldSettings(long objectFieldId)
    • getObjectFieldSetting

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

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectFieldSettingsCount()
      Returns the number of object field settings.
      Returns:
      the number of object field settings
    • 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
    • updateObjectFieldSetting

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

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