Class DDMFieldLocalServiceUtil
com.liferay.dynamic.data.mapping.service.impl.DDMFieldLocalServiceImpl
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 DDMField
addDDMField
(DDMField ddmField) Adds the ddm field to the database.static DDMField
createDDMField
(long fieldId) Creates a new ddm field with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static DDMField
deleteDDMField
(long fieldId) Deletes the ddm field with the primary key from the database.static DDMField
deleteDDMField
(DDMField ddmField) Deletes the ddm field from the database.static void
deleteDDMFields
(long structureId) static void
deleteDDMFormValues
(long storageId) static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
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.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 long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.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.static DDMField
fetchDDMField
(long fieldId) static DDMFieldAttribute
fetchDDMFieldAttribute
(long fieldId, String attributeName, String languageId) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static DDMField
getDDMField
(long fieldId) Returns the ddm field with the primary key.static List<DDMFieldAttribute>
getDDMFieldAttributes
(long storageId, String attributeName) getDDMFields
(int start, int end) Returns a range of all the ddm fields.getDDMFields
(long storageId, String fieldName) static int
Returns the number of ddm fields.static DDMFormValues
getDDMFormValues
(DDMForm ddmForm, long storageId) static DDMFormValues
getDDMFormValues
(DDMForm ddmForm, long storageId, String languageId) static int
getDDMFormValuesCount
(long structureId) static int
getDDMFormValuesCount
(long companyId, String fieldType, Map<String, Object> attributes) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static DDMFieldLocalService
static DDMField
updateDDMField
(DDMField ddmField) Updates the ddm field in the database or adds it if it does not yet exist.static void
updateDDMFormValues
(long structureId, long storageId, DDMFormValues ddmFormValues)
-
Constructor Details
-
DDMFieldLocalServiceUtil
public DDMFieldLocalServiceUtil()
-
-
Method Details
-
addDDMField
Adds the ddm field to the database. Also notifies the appropriate model listeners.Important: Inspect DDMFieldLocalServiceImpl 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:
ddmField
- the ddm field- Returns:
- the ddm field that was added
-
createDDMField
Creates a new ddm field with the primary key. Does not add the ddm field to the database.- Parameters:
fieldId
- the primary key for the new ddm field- Returns:
- the new ddm field
-
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
-
deleteDDMField
Deletes the ddm field from the database. Also notifies the appropriate model listeners.Important: Inspect DDMFieldLocalServiceImpl 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:
ddmField
- the ddm field- Returns:
- the ddm field that was removed
-
deleteDDMField
public static DDMField deleteDDMField(long fieldId) throws com.liferay.portal.kernel.exception.PortalException Deletes the ddm field with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect DDMFieldLocalServiceImpl 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:
fieldId
- the primary key of the ddm field- Returns:
- the ddm field that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a ddm field with the primary key could not be found
-
deleteDDMFields
public static void deleteDDMFields(long structureId) -
deleteDDMFormValues
public static void deleteDDMFormValues(long storageId) -
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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.mapping.model.impl.DDMFieldModelImpl
.- 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.mapping.model.impl.DDMFieldModelImpl
.- 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
-
fetchDDMField
-
fetchDDMFieldAttribute
public static DDMFieldAttribute fetchDDMFieldAttribute(long fieldId, String attributeName, String languageId) -
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getDDMField
public static DDMField getDDMField(long fieldId) throws com.liferay.portal.kernel.exception.PortalException Returns the ddm field with the primary key.- Parameters:
fieldId
- the primary key of the ddm field- Returns:
- the ddm field
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a ddm field with the primary key could not be found
-
getDDMFieldAttributes
-
getDDMFields
Returns a range of all the ddm fields.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.mapping.model.impl.DDMFieldModelImpl
.- Parameters:
start
- the lower bound of the range of ddm fieldsend
- the upper bound of the range of ddm fields (not inclusive)- Returns:
- the range of ddm fields
-
getDDMFields
-
getDDMFieldsCount
public static int getDDMFieldsCount()Returns the number of ddm fields.- Returns:
- the number of ddm fields
-
getDDMFormValues
-
getDDMFormValues
-
getDDMFormValuesCount
public static int getDDMFormValuesCount(long structureId) -
getDDMFormValuesCount
-
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
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
-
updateDDMField
Updates the ddm field in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect DDMFieldLocalServiceImpl 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:
ddmField
- the ddm field- Returns:
- the ddm field that was updated
-
updateDDMFormValues
public static void updateDDMFormValues(long structureId, long storageId, DDMFormValues ddmFormValues) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-