Interface ExpandoTableLocalService
- All Superinterfaces:
BaseLocalService
,CTService<ExpandoTable>
,PersistedModelLocalService
- All Known Implementing Classes:
ExpandoTableLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddDefaultTable
(long companyId, long classNameId) addDefaultTable
(long companyId, String className) addExpandoTable
(ExpandoTable expandoTable) Adds the expando table to the database.createExpandoTable
(long tableId) Creates a new expando table with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteExpandoTable
(long tableId) Deletes the expando table with the primary key from the database.deleteExpandoTable
(ExpandoTable expandoTable) Deletes the expando table from the database.deletePersistedModel
(PersistedModel persistedModel) void
deleteTable
(long tableId) void
deleteTable
(long companyId, long classNameId, String name) void
deleteTable
(long companyId, String className, String name) void
deleteTable
(ExpandoTable table) void
deleteTables
(long companyId, long classNameId) void
deleteTables
(long companyId, String className) <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.fetchDefaultTable
(long companyId, long classNameId) fetchDefaultTable
(long companyId, String className) fetchExpandoTable
(long tableId) fetchTable
(long companyId, long classNameId, String name) getDefaultTable
(long companyId, long classNameId) getDefaultTable
(long companyId, String className) getExpandoTable
(long tableId) Returns the expando table with the primary key.getExpandoTables
(int start, int end) Returns a range of all the expando tables.int
Returns the number of expando tables.Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getTable
(long tableId) getTables
(long companyId, long classNameId) updateExpandoTable
(ExpandoTable expandoTable) Updates the expando table in the database or adds it if it does not yet exist.updateTable
(long tableId, String name) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<ExpandoTable>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addDefaultTable
- Throws:
PortalException
-
addDefaultTable
- Throws:
PortalException
-
addExpandoTable
Adds the expando table to the database. Also notifies the appropriate model listeners.Important: Inspect ExpandoTableLocalServiceImpl 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:
expandoTable
- the expando table- Returns:
- the expando table that was added
-
addTable
- Throws:
PortalException
-
addTable
- Throws:
PortalException
-
createExpandoTable
Creates a new expando table with the primary key. Does not add the expando table to the database.- Parameters:
tableId
- the primary key for the new expando table- Returns:
- the new expando table
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteExpandoTable
@Indexable(type=DELETE) ExpandoTable deleteExpandoTable(ExpandoTable expandoTable) throws PortalException Deletes the expando table from the database. Also notifies the appropriate model listeners.Important: Inspect ExpandoTableLocalServiceImpl 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:
expandoTable
- the expando table- Returns:
- the expando table that was removed
- Throws:
PortalException
-
deleteExpandoTable
Deletes the expando table with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect ExpandoTableLocalServiceImpl 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:
tableId
- the primary key of the expando table- Returns:
- the expando table that was removed
- Throws:
PortalException
- if a expando table with the primary key could not be found
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteTable
- Throws:
PortalException
-
deleteTable
- Throws:
PortalException
-
deleteTable
- Throws:
PortalException
-
deleteTable
- Throws:
PortalException
-
deleteTables
- Throws:
PortalException
-
deleteTables
- 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.ExpandoTableModelImpl
.- 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.ExpandoTableModelImpl
.- 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
-
fetchDefaultTable
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoTable fetchDefaultTable(long companyId, long classNameId) -
fetchDefaultTable
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoTable fetchDefaultTable(long companyId, String className) -
fetchExpandoTable
-
fetchTable
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoTable fetchTable(long companyId, long classNameId, String name) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getDefaultTable
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoTable getDefaultTable(long companyId, long classNameId) throws PortalException - Throws:
PortalException
-
getDefaultTable
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoTable getDefaultTable(long companyId, String className) throws PortalException - Throws:
PortalException
-
getExpandoTable
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoTable getExpandoTable(long tableId) throws PortalException Returns the expando table with the primary key.- Parameters:
tableId
- the primary key of the expando table- Returns:
- the expando table
- Throws:
PortalException
- if a expando table with the primary key could not be found
-
getExpandoTables
@Transactional(propagation=SUPPORTS, readOnly=true) List<ExpandoTable> getExpandoTables(int start, int end) Returns a range of all the expando tables.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.ExpandoTableModelImpl
.- Parameters:
start
- the lower bound of the range of expando tablesend
- the upper bound of the range of expando tables (not inclusive)- Returns:
- the range of expando tables
-
getExpandoTablesCount
Returns the number of expando tables.- Returns:
- the number of expando tables
-
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
-
getTable
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoTable getTable(long tableId) throws PortalException - Throws:
PortalException
-
getTable
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoTable getTable(long companyId, long classNameId, String name) throws PortalException - Throws:
PortalException
-
getTable
@Transactional(propagation=SUPPORTS, readOnly=true) ExpandoTable getTable(long companyId, String className, String name) throws PortalException - Throws:
PortalException
-
getTables
@Transactional(propagation=SUPPORTS, readOnly=true) List<ExpandoTable> getTables(long companyId, long classNameId) -
getTables
@Transactional(propagation=SUPPORTS, readOnly=true) List<ExpandoTable> getTables(long companyId, String className) -
updateExpandoTable
Updates the expando table in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect ExpandoTableLocalServiceImpl 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:
expandoTable
- the expando table- Returns:
- the expando table that was updated
-
updateTable
- Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<ExpandoTable>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<ExpandoTable>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<ExpandoTable>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<ExpandoTable>
- Throws:
E extends Throwable
-