com.liferay.dynamic.data.mapping.service

Interface DDMFieldLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<DDMField>, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

DDMFieldLocalServiceWrapper

@CTAware
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface DDMFieldLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<DDMField>, com.liferay.portal.kernel.service.PersistedModelLocalService

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

DDMFieldLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
DDMField	addDDMField(DDMField ddmField) Adds the ddm field to the database.
DDMField	createDDMField(long fieldId) Creates a new ddm field with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
DDMField	deleteDDMField(DDMField ddmField) Deletes the ddm field from the database.
DDMField	deleteDDMField(long fieldId) Deletes the ddm field with the primary key from the database.
void	deleteDDMFields(long structureId)
void	deleteDDMFormValues(long storageId)
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<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.
<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.
<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.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
DDMField	fetchDDMField(long fieldId)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDMField>	getCTPersistence()
DDMField	getDDMField(long fieldId) Returns the ddm field with the primary key.
java.util.List<DDMField>	getDDMFields(int start, int end) Returns a range of all the ddm fields.
int	getDDMFieldsCount() Returns the number of ddm fields.
DDMFormValues	getDDMFormValues(DDMForm ddmForm, long storageId)
int	getDDMFormValuesCount(long structureId)
int	getDDMFormValuesCount(long companyId, java.lang.String fieldType, java.util.Map<java.lang.String,java.lang.Object> attributes)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.Class<DDMField>	getModelClass()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
DDMField	updateDDMField(DDMField ddmField) Updates the ddm field in the database or adds it if it does not yet exist.
void	updateDDMFormValues(long structureId, long storageId, DDMFormValues ddmFormValues)
<R,E extends java.lang.Throwable> R	updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDMField>,R,E> updateUnsafeFunction)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addDDMField

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

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

com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.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

deleteDDMField

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

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

void deleteDDMFields(long structureId)

deleteDDMFormValues

void deleteDDMFormValues(long storageId)

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)

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

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

dynamicQuery

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

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

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

@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

fetchDDMField

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMField fetchDDMField(long fieldId)

getActionableDynamicQuery

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

getDDMField

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDDMFieldsCount()

Returns the number of ddm fields.

Returns:

the number of ddm fields

getDDMFormValues

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMFormValues getDDMFormValues(DDMForm ddmForm,
                                                                                                  long storageId)

getDDMFormValuesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDDMFormValuesCount(long structureId)

getDDMFormValuesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDDMFormValuesCount(long companyId,
                                                                                             java.lang.String fieldType,
                                                                                             java.util.Map<java.lang.String,java.lang.Object> attributes)

getIndexableActionableDynamicQuery

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

getOSGiServiceIdentifier

java.lang.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(java.io.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

updateDDMField

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

void updateDDMFormValues(long structureId,
                         long storageId,
                         DDMFormValues ddmFormValues)
                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCTPersistence

@Transactional(enabled=false)
com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDMField> getCTPersistence()

Specified by:

getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<DDMField>

getModelClass

@Transactional(enabled=false)
java.lang.Class<DDMField> getModelClass()

Specified by:

getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<DDMField>

updateWithUnsafeFunction

@Transactional(rollbackFor=java.lang.Throwable.class)
<R,E extends java.lang.Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDMField>,R,E> updateUnsafeFunction)
                                                                                                            throws E extends java.lang.Throwable

Specified by:

updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<DDMField>

Throws:

E extends java.lang.Throwable