Class ObjectFieldSettingLocalServiceUtil
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ObjectFieldSettingaddObjectFieldSetting(long userId, long objectFieldId, String name, String value) static ObjectFieldSettingaddObjectFieldSetting(ObjectFieldSetting objectFieldSetting) Adds the object field setting to the database.static ObjectFieldSettingcreateObjectFieldSetting(long objectFieldSettingId) Creates a new object field setting with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static voiddeleteObjectFieldObjectFieldSetting(ObjectField objectField) static ObjectFieldSettingdeleteObjectFieldSetting(long objectFieldSettingId) Deletes the object field setting with the primary key from the database.static ObjectFieldSettingdeleteObjectFieldSetting(ObjectFieldSetting objectFieldSetting) Deletes the object field setting from the database.static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <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 longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(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 ObjectFieldSettingfetchObjectFieldSetting(long objectFieldSettingId) static ObjectFieldSettingfetchObjectFieldSetting(long objectFieldId, String name) static ObjectFieldSettingfetchObjectFieldSettingByUuidAndCompanyId(String uuid, long companyId) Returns the object field setting with the matching UUID and company.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic List<ObjectFieldSetting>getObjectFieldObjectFieldSettings(long objectFieldId) static ObjectFieldSettinggetObjectFieldSetting(long objectFieldSettingId) Returns the object field setting with the primary key.static ObjectFieldSettinggetObjectFieldSettingByUuidAndCompanyId(String uuid, long companyId) Returns the object field setting with the matching UUID and company.static List<ObjectFieldSetting>getObjectFieldSettings(int start, int end) Returns a range of all the object field settings.static intReturns the number of object field settings.static StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static ObjectFieldSettingupdateObjectFieldSetting(long objectFieldSettingId, String value) static ObjectFieldSettingupdateObjectFieldSetting(ObjectFieldSetting objectFieldSetting) Updates the object field setting in the database or adds it if it does not yet exist.
-
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
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
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
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
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.object.model.impl.ObjectFieldSettingModelImpl.- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.object.model.impl.ObjectFieldSettingModelImpl.- 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
-
fetchObjectFieldSetting
-
fetchObjectFieldSetting
-
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 UUIDcompanyId- the primary key of the company- Returns:
- the matching object field setting, or
nullif 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
-
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 UUIDcompanyId- 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
Returns a range of all the object field settings.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.object.model.impl.ObjectFieldSettingModelImpl.- Parameters:
start- the lower bound of the range of object field settingsend- 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
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
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
-