Interface ExpandoColumnLocalService
- All Superinterfaces:
BaseLocalService
,CTService<ExpandoColumn>
,PersistedModelLocalService
- All Known Implementing Classes:
ExpandoColumnLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddExpandoColumn
(ExpandoColumn expandoColumn) Adds the expando column to the database.createExpandoColumn
(long columnId) Creates a new expando column with the primary key.createPersistedModel
(Serializable primaryKeyObj) void
deleteColumn
(long columnId) void
deleteColumn
(long companyId, long classNameId, String tableName, String name) void
deleteColumn
(long tableId, String name) void
deleteColumn
(long companyId, String className, String tableName, String name) void
deleteColumn
(ExpandoColumn column) void
deleteColumns
(long tableId) void
deleteColumns
(long companyId, long classNameId, String tableName) void
deleteColumns
(long companyId, String className, String tableName) deleteExpandoColumn
(long columnId) Deletes the expando column with the primary key from the database.deleteExpandoColumn
(ExpandoColumn expandoColumn) Deletes the expando column from the database.deletePersistedModel
(PersistedModel persistedModel) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> List<T>
dynamicQuery
(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
(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.fetchColumn
(long companyId, long classNameId, String tableName, String name) fetchColumn
(long tableId, String name) fetchExpandoColumn
(long columnId) getColumn
(long columnId) getColumns
(long tableId) getColumns
(long companyId, long classNameId, String tableName) getColumns
(long companyId, long classNameId, String tableName, Collection<String> names) getColumns
(long companyId, String className, String tableName) getColumns
(long companyId, String className, String tableName, Collection<String> columnNames) getColumns
(long tableId, Collection<String> names) int
getColumnsCount
(long tableId) int
getColumnsCount
(long companyId, long classNameId, String tableName) int
getColumnsCount
(long companyId, String className, String tableName) getDefaultTableColumn
(long companyId, long classNameId, String name) getDefaultTableColumn
(long companyId, String className, String name) getDefaultTableColumns
(long companyId, long classNameId) getDefaultTableColumns
(long companyId, String className) int
getDefaultTableColumnsCount
(long companyId, long classNameId) int
getDefaultTableColumnsCount
(long companyId, String className) getExpandoColumn
(long columnId) Returns the expando column with the primary key.getExpandoColumns
(int start, int end) Returns a range of all the expando columns.int
Returns the number of expando columns.Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) updateColumn
(long columnId, String name, int type) updateColumn
(long columnId, String name, int type, Object defaultData) updateExpandoColumn
(ExpandoColumn expandoColumn) Updates the expando column in the database or adds it if it does not yet exist.updateTypeSettings
(long columnId, String typeSettings) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<ExpandoColumn>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addColumn
- Throws:
PortalException
-
addColumn
ExpandoColumn addColumn(long tableId, String name, int type, Object defaultData) throws PortalException - Throws:
PortalException
-
addExpandoColumn
Adds the expando column to the database. Also notifies the appropriate model listeners.Important: Inspect ExpandoColumnLocalServiceImpl 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:
expandoColumn
- the expando column- Returns:
- the expando column that was added
-
createExpandoColumn
Creates a new expando column with the primary key. Does not add the expando column to the database.- Parameters:
columnId
- the primary key for the new expando column- Returns:
- the new expando column
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteColumn
- Throws:
PortalException
-
deleteColumn
- Throws:
PortalException
-
deleteColumn
void deleteColumn(long companyId, long classNameId, String tableName, String name) throws PortalException - Throws:
PortalException
-
deleteColumn
- Throws:
PortalException
-
deleteColumn
void deleteColumn(long companyId, String className, String tableName, String name) throws PortalException - Throws:
PortalException
-
deleteColumns
- Throws:
PortalException
-
deleteColumns
- Throws:
PortalException
-
deleteColumns
- Throws:
PortalException
-
deleteExpandoColumn
Deletes the expando column from the database. Also notifies the appropriate model listeners.Important: Inspect ExpandoColumnLocalServiceImpl 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:
expandoColumn
- the expando column- Returns:
- the expando column that was removed
-
deleteExpandoColumn
Deletes the expando column with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect ExpandoColumnLocalServiceImpl 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:
columnId
- the primary key of the expando column- Returns:
- the expando column that was removed
- Throws:
PortalException
- if a expando column with the primary key could not be found
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> 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
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(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.portlet.expando.model.impl.ExpandoColumnModelImpl
.- 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(DynamicQuery dynamicQuery, int start, int end, 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.portlet.expando.model.impl.ExpandoColumnModelImpl
.- 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(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(DynamicQuery dynamicQuery, 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
-
fetchColumn
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoColumn fetchColumn(long companyId, long classNameId, String tableName, String name) -
fetchColumn
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoColumn fetchColumn(long tableId, String name) -
fetchExpandoColumn
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getColumn
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoColumn getColumn(long columnId) throws PortalException - Throws:
PortalException
-
getColumn
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoColumn getColumn(long companyId, long classNameId, String tableName, String name) throws PortalException - Throws:
PortalException
-
getColumn
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoColumn getColumn(long tableId, String name) throws PortalException - Throws:
PortalException
-
getColumn
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoColumn getColumn(long companyId, String className, String tableName, String name) -
getColumns
-
getColumns
@Transactional(propagation=SUPPORTS, readOnly=true) List<ExpandoColumn> getColumns(long tableId, Collection<String> names) -
getColumns
@Transactional(propagation=SUPPORTS, readOnly=true) List<ExpandoColumn> getColumns(long companyId, long classNameId, String tableName) -
getColumns
@Transactional(propagation=SUPPORTS, readOnly=true) List<ExpandoColumn> getColumns(long companyId, long classNameId, String tableName, Collection<String> names) -
getColumns
@Transactional(propagation=SUPPORTS, readOnly=true) List<ExpandoColumn> getColumns(long companyId, String className, String tableName) -
getColumns
@Transactional(propagation=SUPPORTS, readOnly=true) List<ExpandoColumn> getColumns(long companyId, String className, String tableName, Collection<String> columnNames) -
getColumnsCount
-
getColumnsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getColumnsCount(long companyId, long classNameId, String tableName) -
getColumnsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getColumnsCount(long companyId, String className, String tableName) -
getDefaultTableColumn
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoColumn getDefaultTableColumn(long companyId, long classNameId, String name) -
getDefaultTableColumn
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoColumn getDefaultTableColumn(long companyId, String className, String name) -
getDefaultTableColumns
@Transactional(propagation=SUPPORTS, readOnly=true) List<ExpandoColumn> getDefaultTableColumns(long companyId, long classNameId) -
getDefaultTableColumns
@Transactional(propagation=SUPPORTS, readOnly=true) List<ExpandoColumn> getDefaultTableColumns(long companyId, String className) -
getDefaultTableColumnsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getDefaultTableColumnsCount(long companyId, long classNameId) -
getDefaultTableColumnsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getDefaultTableColumnsCount(long companyId, String className) -
getExpandoColumn
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoColumn getExpandoColumn(long columnId) throws PortalException Returns the expando column with the primary key.- Parameters:
columnId
- the primary key of the expando column- Returns:
- the expando column
- Throws:
PortalException
- if a expando column with the primary key could not be found
-
getExpandoColumns
@Transactional(propagation=SUPPORTS, readOnly=true) List<ExpandoColumn> getExpandoColumns(int start, int end) Returns a range of all the expando columns.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.portlet.expando.model.impl.ExpandoColumnModelImpl
.- Parameters:
start
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)- Returns:
- the range of expando columns
-
getExpandoColumnsCount
Returns the number of expando columns.- Returns:
- the number of expando columns
-
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
updateColumn
- Throws:
PortalException
-
updateColumn
ExpandoColumn updateColumn(long columnId, String name, int type, Object defaultData) throws PortalException - Throws:
PortalException
-
updateExpandoColumn
Updates the expando column in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect ExpandoColumnLocalServiceImpl 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:
expandoColumn
- the expando column- Returns:
- the expando column that was updated
-
updateTypeSettings
- Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<ExpandoColumn>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<ExpandoColumn>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<ExpandoColumn>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<ExpandoColumn>
- Throws:
E extends Throwable
-