Class ExpandoTableLocalServiceUtil
com.liferay.portlet.expando.service.impl.ExpandoTableLocalServiceImpl
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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ExpandoTable
addDefaultTable
(long companyId, long classNameId) static ExpandoTable
addDefaultTable
(long companyId, String className) static ExpandoTable
addExpandoTable
(ExpandoTable expandoTable) Adds the expando table to the database.static ExpandoTable
static ExpandoTable
static ExpandoTable
createExpandoTable
(long tableId) Creates a new expando table with the primary key.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static ExpandoTable
deleteExpandoTable
(long tableId) Deletes the expando table with the primary key from the database.static ExpandoTable
deleteExpandoTable
(ExpandoTable expandoTable) Deletes the expando table from the database.static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static void
deleteTable
(long tableId) static void
deleteTable
(long companyId, long classNameId, String name) static void
deleteTable
(long companyId, String className, String name) static void
deleteTable
(ExpandoTable table) static void
deleteTables
(long companyId, long classNameId) static void
deleteTables
(long companyId, String className) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static ExpandoTable
fetchDefaultTable
(long companyId, long classNameId) static ExpandoTable
fetchDefaultTable
(long companyId, String className) static ExpandoTable
fetchExpandoTable
(long tableId) static ExpandoTable
fetchTable
(long companyId, long classNameId, String name) static ActionableDynamicQuery
static ExpandoTable
getDefaultTable
(long companyId, long classNameId) static ExpandoTable
getDefaultTable
(long companyId, String className) static ExpandoTable
getExpandoTable
(long tableId) Returns the expando table with the primary key.static List<ExpandoTable>
getExpandoTables
(int start, int end) Returns a range of all the expando tables.static int
Returns the number of expando tables.static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static ExpandoTableLocalService
static ExpandoTable
getTable
(long tableId) static ExpandoTable
static ExpandoTable
static List<ExpandoTable>
getTables
(long companyId, long classNameId) static List<ExpandoTable>
static void
setService
(ExpandoTableLocalService service) static ExpandoTable
updateExpandoTable
(ExpandoTable expandoTable) Updates the expando table in the database or adds it if it does not yet exist.static ExpandoTable
updateTable
(long tableId, String name)
-
Constructor Details
-
ExpandoTableLocalServiceUtil
public ExpandoTableLocalServiceUtil()
-
-
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
public static ExpandoTable addTable(long companyId, long classNameId, String name) throws PortalException - Throws:
PortalException
-
addTable
public static ExpandoTable addTable(long companyId, String className, String name) throws PortalException - 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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteExpandoTable
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
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deleteTable
- Throws:
PortalException
-
deleteTable
- Throws:
PortalException
-
deleteTable
public static void deleteTable(long companyId, long classNameId, String name) throws PortalException - Throws:
PortalException
-
deleteTable
public static void deleteTable(long companyId, String className, String name) throws PortalException - Throws:
PortalException
-
deleteTables
- Throws:
PortalException
-
deleteTables
- Throws:
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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
public static <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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
-
fetchDefaultTable
-
fetchExpandoTable
-
fetchTable
-
getActionableDynamicQuery
-
getDefaultTable
- Throws:
PortalException
-
getDefaultTable
- Throws:
PortalException
-
getExpandoTable
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
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
public static int getExpandoTablesCount()Returns the number of expando tables.- Returns:
- the number of expando tables
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getTable
- Throws:
PortalException
-
getTable
public static ExpandoTable getTable(long companyId, long classNameId, String name) throws PortalException - Throws:
PortalException
-
getTable
public static ExpandoTable getTable(long companyId, String className, String name) throws PortalException - Throws:
PortalException
-
getTables
-
getTables
-
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
-
getService
-
setService
-