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
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddDDMField(DDMField ddmField) Adds the ddm field to the database.createDDMField(long fieldId) Creates a new ddm field with the primary key.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) deleteDDMField(long fieldId) Deletes the ddm field with the primary key from the database.deleteDDMField(DDMField ddmField) Deletes the ddm field from the database.voiddeleteDDMFields(long structureId) voiddeleteDDMFormValues(long storageId) com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.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.fetchDDMField(long fieldId) fetchDDMFieldAttribute(long fieldId, String attributeName, String languageId) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerycom.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDMField>getDDMField(long fieldId) Returns the ddm field with the primary key.getDDMFieldAttributes(long storageId, String attributeName) getDDMFields(int start, int end) Returns a range of all the ddm fields.getDDMFields(long storageId, String fieldName) intReturns the number of ddm fields.getDDMFormValues(DDMForm ddmForm, long storageId) getDDMFormValues(DDMForm ddmForm, long storageId, String languageId) intgetDDMFormValuesCount(long structureId) intgetDDMFormValuesCount(long companyId, String fieldType, Map<String, Object> attributes) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQueryReturns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) updateDDMField(DDMField ddmField) Updates the ddm field in the database or adds it if it does not yet exist.voidupdateDDMFormValues(long structureId, long storageId, DDMFormValues ddmFormValues) <R,E extends Throwable>
RupdateWithUnsafeFunction(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
fetchPersistedModel, getBasePersistence
-
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
com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- 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
@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:
deletePersistedModelin interfacecom.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:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacecom.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 - 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.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
@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 - 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.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
@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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDDMField
-
fetchDDMFieldAttribute
@Transactional(propagation=SUPPORTS, readOnly=true) DDMFieldAttribute fetchDDMFieldAttribute(long fieldId, String attributeName, String languageId) -
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
-
getDDMFieldAttributes
@Transactional(propagation=SUPPORTS, readOnly=true) List<DDMFieldAttribute> getDDMFieldAttributes(long storageId, String attributeName) -
getDDMFields
Returns a range of all the ddm fields.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.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
@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) -
getDDMFormValues
@Transactional(propagation=SUPPORTS, readOnly=true) DDMFormValues getDDMFormValues(DDMForm ddmForm, long storageId, String languageId) -
getDDMFormValuesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getDDMFormValuesCount(long structureId) -
getDDMFormValuesCount
-
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
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:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- 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
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:
getCTPersistencein interfacecom.liferay.portal.kernel.service.change.tracking.CTService<DDMField>
-
getModelClass
- Specified by:
getModelClassin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<DDMField>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDMField>, R, throws EE> updateUnsafeFunction)
-