com.liferay.portlet.expando.service
Class ExpandoTableLocalServiceUtil

java.lang.Object
  com.liferay.portlet.expando.service.ExpandoTableLocalServiceUtil

@ProviderType
public class ExpandoTableLocalServiceUtil
extends Object

Provides the local service utility for ExpandoTable. This utility wraps com.liferay.portlet.expando.service.impl.ExpandoTableLocalServiceImpl and is the primary 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.

See Also:

ExpandoTableLocalService, com.liferay.portlet.expando.service.base.ExpandoTableLocalServiceBaseImpl, com.liferay.portlet.expando.service.impl.ExpandoTableLocalServiceImpl

Constructor Summary

ExpandoTableLocalServiceUtil()

Method Summary

static 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	addTable(long companyId, long classNameId, String name)
static ExpandoTable	addTable(long classNameId, String name) Deprecated. As of 6.1.0, replaced by addTable(long, long, String)
static ExpandoTable	addTable(long companyId, String className, String name)
static ExpandoTable	addTable(String className, String name) Deprecated. As of 6.1.0, replaced by addTable(long, String, String)
static ExpandoTable	createExpandoTable(long tableId) Creates a new expando table with the primary key.
static ExpandoTable	deleteExpandoTable(ExpandoTable expandoTable) Deletes the expando table from the database.
static ExpandoTable	deleteExpandoTable(long tableId) Deletes the expando table with the primary key from the database.
static void	deleteTable(ExpandoTable table)
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	deleteTables(long companyId, long classNameId)
static void	deleteTables(long companyId, String className)
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match 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 String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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	getExpandoTablesCount() Returns the number of expando tables.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static ExpandoTableLocalService	getService()
static ExpandoTable	getTable(long tableId)
static ExpandoTable	getTable(long companyId, long classNameId, String name)
static ExpandoTable	getTable(long classNameId, String name) Deprecated. As of 6.1.0, replaced by getTable(long, long, String)
static ExpandoTable	getTable(long companyId, String className, String name)
static ExpandoTable	getTable(String className, String name) Deprecated. As of 6.1.0, replaced by getTable(long, String, String)
static List<ExpandoTable>	getTables(long companyId, long classNameId)
static List<ExpandoTable>	getTables(long companyId, String className)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(ExpandoTableLocalService service) Deprecated. As of 6.2.0
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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExpandoTableLocalServiceUtil

public ExpandoTableLocalServiceUtil()

Method Detail

addExpandoTable

public static ExpandoTable addExpandoTable(ExpandoTable expandoTable)
                                    throws SystemException

Adds the expando table to the database. Also notifies the appropriate model listeners.

Parameters:

expandoTable - the expando table

Returns:

the expando table that was added

Throws:

SystemException - if a system exception occurred

createExpandoTable

public static ExpandoTable createExpandoTable(long tableId)

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

deleteExpandoTable

public static ExpandoTable deleteExpandoTable(long tableId)
                                       throws PortalException,
                                              SystemException

Deletes the expando table with the primary key from the database. Also notifies the appropriate model listeners.

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

SystemException - if a system exception occurred

deleteExpandoTable

public static ExpandoTable deleteExpandoTable(ExpandoTable expandoTable)
                                       throws SystemException

Deletes the expando table from the database. Also notifies the appropriate model listeners.

Parameters:

expandoTable - the expando table

Returns:

the expando table that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoTableModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoTableModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchExpandoTable

public static ExpandoTable fetchExpandoTable(long tableId)
                                      throws SystemException

Throws:

SystemException

getExpandoTable

public static ExpandoTable getExpandoTable(long tableId)
                                    throws PortalException,
                                           SystemException

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getExpandoTables

public static List<ExpandoTable> getExpandoTables(int start,
                                                  int end)
                                           throws SystemException

Returns a range of all the expando tables.

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoTableModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of expando tables

end - the upper bound of the range of expando tables (not inclusive)

Returns:

the range of expando tables

Throws:

SystemException - if a system exception occurred

getExpandoTablesCount

public static int getExpandoTablesCount()
                                 throws SystemException

Returns the number of expando tables.

Returns:

the number of expando tables

Throws:

SystemException - if a system exception occurred

updateExpandoTable

public static ExpandoTable updateExpandoTable(ExpandoTable expandoTable)
                                       throws SystemException

Updates the expando table in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

expandoTable - the expando table

Returns:

the expando table that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addDefaultTable

public static ExpandoTable addDefaultTable(long companyId,
                                           long classNameId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

addDefaultTable

public static ExpandoTable addDefaultTable(long companyId,
                                           String className)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

addTable

public static ExpandoTable addTable(long companyId,
                                    long classNameId,
                                    String name)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

addTable

public static ExpandoTable addTable(long classNameId,
                                    String name)
                             throws PortalException,
                                    SystemException

Deprecated. As of 6.1.0, replaced by addTable(long, long, String)

Throws:

PortalException

SystemException

addTable

public static ExpandoTable addTable(long companyId,
                                    String className,
                                    String name)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

addTable

public static ExpandoTable addTable(String className,
                                    String name)
                             throws PortalException,
                                    SystemException

Deprecated. As of 6.1.0, replaced by addTable(long, String, String)

Throws:

PortalException

SystemException

deleteTable

public static void deleteTable(ExpandoTable table)
                        throws SystemException

Throws:

SystemException

deleteTable

public static void deleteTable(long tableId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteTable

public static void deleteTable(long companyId,
                               long classNameId,
                               String name)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteTable

public static void deleteTable(long companyId,
                               String className,
                               String name)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteTables

public static void deleteTables(long companyId,
                                long classNameId)
                         throws SystemException

Throws:

SystemException

deleteTables

public static void deleteTables(long companyId,
                                String className)
                         throws SystemException

Throws:

SystemException

fetchDefaultTable

public static ExpandoTable fetchDefaultTable(long companyId,
                                             long classNameId)
                                      throws SystemException

Throws:

SystemException

fetchDefaultTable

public static ExpandoTable fetchDefaultTable(long companyId,
                                             String className)
                                      throws SystemException

Throws:

SystemException

fetchTable

public static ExpandoTable fetchTable(long companyId,
                                      long classNameId,
                                      String name)
                               throws SystemException

Throws:

SystemException

getDefaultTable

public static ExpandoTable getDefaultTable(long companyId,
                                           long classNameId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getDefaultTable

public static ExpandoTable getDefaultTable(long companyId,
                                           String className)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getTable

public static ExpandoTable getTable(long tableId)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getTable

public static ExpandoTable getTable(long companyId,
                                    long classNameId,
                                    String name)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getTable

public static ExpandoTable getTable(long classNameId,
                                    String name)
                             throws PortalException,
                                    SystemException

Deprecated. As of 6.1.0, replaced by getTable(long, long, String)

Throws:

PortalException

SystemException

getTable

public static ExpandoTable getTable(long companyId,
                                    String className,
                                    String name)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getTable

public static ExpandoTable getTable(String className,
                                    String name)
                             throws PortalException,
                                    SystemException

Deprecated. As of 6.1.0, replaced by getTable(long, String, String)

Throws:

PortalException

SystemException

getTables

public static List<ExpandoTable> getTables(long companyId,
                                           long classNameId)
                                    throws SystemException

Throws:

SystemException

getTables

public static List<ExpandoTable> getTables(long companyId,
                                           String className)
                                    throws SystemException

Throws:

SystemException

updateTable

public static ExpandoTable updateTable(long tableId,
                                       String name)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getService

public static ExpandoTableLocalService getService()

setService

public void setService(ExpandoTableLocalService service)

Deprecated. As of 6.2.0