com.liferay.dynamic.data.mapping.service

Class DDMFieldLocalServiceUtil

java.lang.Object

com.liferay.dynamic.data.mapping.service.DDMFieldLocalServiceUtil

public class DDMFieldLocalServiceUtil
extends java.lang.Object

Provides the local service utility for DDMField. This utility wraps 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:

DDMFieldLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
DDMFieldLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static 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(java.io.Serializable primaryKeyObj)
static DDMField	deleteDDMField(DDMField ddmField) Deletes the ddm field from the database.
static DDMField	deleteDDMField(long fieldId) Deletes the ddm field with the primary key 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	dynamicQuery()
static <T> java.util.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> java.util.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> java.util.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 com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static DDMField	getDDMField(long fieldId) Returns the ddm field with the primary key.
static java.util.List<DDMField>	getDDMFields(int start, int end) Returns a range of all the ddm fields.
static int	getDDMFieldsCount() Returns the number of ddm fields.
static DDMFormValues	getDDMFormValues(DDMForm ddmForm, long storageId)
static int	getDDMFormValuesCount(long structureId)
static int	getDDMFormValuesCount(long companyId, java.lang.String fieldType, java.util.Map<java.lang.String,java.lang.Object> attributes)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static DDMFieldLocalService	getService()
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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DDMFieldLocalServiceUtil

public DDMFieldLocalServiceUtil()

Method Detail

addDDMField

public static DDMField addDDMField(DDMField ddmField)

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

public static DDMField createDDMField(long fieldId)

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(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteDDMField

public static DDMField deleteDDMField(DDMField ddmField)

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

public static <T> java.util.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> java.util.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.dynamic.data.mapping.model.impl.DDMFieldModelImpl.

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> java.util.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.dynamic.data.mapping.model.impl.DDMFieldModelImpl.

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

fetchDDMField

public static DDMField fetchDDMField(long fieldId)

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

getDDMFields

public static java.util.List<DDMField> getDDMFields(int start,
                                                    int end)

Returns a range of all the ddm fields.

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.dynamic.data.mapping.model.impl.DDMFieldModelImpl.

Parameters:

start - the lower bound of the range of ddm fields

end - the upper bound of the range of ddm fields (not inclusive)

Returns:

the range of ddm fields

getDDMFieldsCount

public static int getDDMFieldsCount()

Returns the number of ddm fields.

Returns:

the number of ddm fields

getDDMFormValues

public static DDMFormValues getDDMFormValues(DDMForm ddmForm,
                                             long storageId)

getDDMFormValuesCount

public static int getDDMFormValuesCount(long structureId)

getDDMFormValuesCount

public static int getDDMFormValuesCount(long companyId,
                                        java.lang.String fieldType,
                                        java.util.Map<java.lang.String,java.lang.Object> attributes)

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateDDMField

public static DDMField updateDDMField(DDMField ddmField)

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

public static DDMFieldLocalService getService()