com.liferay.portlet.expando.service
Class ExpandoColumnLocalServiceUtil

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

public class ExpandoColumnLocalServiceUtil
extends Object

The utility for the expando column local service. This utility wraps com.liferay.portlet.expando.service.impl.ExpandoColumnLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. 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:

ExpandoColumnLocalService, com.liferay.portlet.expando.service.base.ExpandoColumnLocalServiceBaseImpl, com.liferay.portlet.expando.service.impl.ExpandoColumnLocalServiceImpl

Constructor Summary

ExpandoColumnLocalServiceUtil()

Method Summary

static ExpandoColumn	addColumn(long tableId, String name, int type)
static ExpandoColumn	addColumn(long tableId, String name, int type, Object defaultData)
static ExpandoColumn	addExpandoColumn(ExpandoColumn expandoColumn) Adds the expando column to the database.
static ExpandoColumn	createExpandoColumn(long columnId) Creates a new expando column with the primary key.
static void	deleteColumn(ExpandoColumn column)
static void	deleteColumn(long columnId)
static void	deleteColumn(long companyId, long classNameId, String tableName, String name)
static void	deleteColumn(long tableId, String name)
static void	deleteColumn(long companyId, String className, String tableName, String name)
static void	deleteColumns(long tableId)
static void	deleteColumns(long companyId, long classNameId, String tableName)
static void	deleteColumns(long companyId, String className, String tableName)
static ExpandoColumn	deleteExpandoColumn(ExpandoColumn expandoColumn) Deletes the expando column from the database.
static ExpandoColumn	deleteExpandoColumn(long columnId) Deletes the expando column with the primary key from the database.
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 ExpandoColumn	fetchExpandoColumn(long columnId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static ExpandoColumn	getColumn(long columnId)
static ExpandoColumn	getColumn(long companyId, long classNameId, String tableName, String name)
static ExpandoColumn	getColumn(long tableId, String name)
static ExpandoColumn	getColumn(long companyId, String className, String tableName, String name)
static List<ExpandoColumn>	getColumns(long tableId)
static List<ExpandoColumn>	getColumns(long tableId, Collection<String> names)
static List<ExpandoColumn>	getColumns(long companyId, long classNameId, String tableName)
static List<ExpandoColumn>	getColumns(long companyId, long classNameId, String tableName, Collection<String> names)
static List<ExpandoColumn>	getColumns(long companyId, String className, String tableName)
static List<ExpandoColumn>	getColumns(long companyId, String className, String tableName, Collection<String> columnNames)
static int	getColumnsCount(long tableId)
static int	getColumnsCount(long companyId, long classNameId, String tableName)
static int	getColumnsCount(long companyId, String className, String tableName)
static ExpandoColumn	getDefaultTableColumn(long companyId, long classNameId, String name)
static ExpandoColumn	getDefaultTableColumn(long companyId, String className, String name)
static List<ExpandoColumn>	getDefaultTableColumns(long companyId, long classNameId)
static List<ExpandoColumn>	getDefaultTableColumns(long companyId, String className)
static int	getDefaultTableColumnsCount(long companyId, long classNameId)
static int	getDefaultTableColumnsCount(long companyId, String className)
static ExpandoColumn	getExpandoColumn(long columnId) Returns the expando column with the primary key.
static List<ExpandoColumn>	getExpandoColumns(int start, int end) Returns a range of all the expando columns.
static int	getExpandoColumnsCount() Returns the number of expando columns.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static ExpandoColumnLocalService	getService()
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(ExpandoColumnLocalService service) Deprecated.
static ExpandoColumn	updateColumn(long columnId, String name, int type)
static ExpandoColumn	updateColumn(long columnId, String name, int type, Object defaultData)
static ExpandoColumn	updateExpandoColumn(ExpandoColumn expandoColumn) Updates the expando column in the database or adds it if it does not yet exist.
static ExpandoColumn	updateExpandoColumn(ExpandoColumn expandoColumn, boolean merge) Updates the expando column in the database or adds it if it does not yet exist.
static ExpandoColumn	updateTypeSettings(long columnId, String typeSettings)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpandoColumnLocalServiceUtil

public ExpandoColumnLocalServiceUtil()

Method Detail

addExpandoColumn

public static ExpandoColumn addExpandoColumn(ExpandoColumn expandoColumn)
                                      throws SystemException

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

Parameters:

expandoColumn - the expando column

Returns:

the expando column that was added

Throws:

SystemException - if a system exception occurred

createExpandoColumn

public static ExpandoColumn createExpandoColumn(long columnId)

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

deleteExpandoColumn

public static ExpandoColumn deleteExpandoColumn(long columnId)
                                         throws PortalException,
                                                SystemException

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

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

SystemException - if a system exception occurred

deleteExpandoColumn

public static ExpandoColumn deleteExpandoColumn(ExpandoColumn expandoColumn)
                                         throws SystemException

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

Parameters:

expandoColumn - the expando column

Returns:

the expando column 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.

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.

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

fetchExpandoColumn

public static ExpandoColumn fetchExpandoColumn(long columnId)
                                        throws SystemException

Throws:

SystemException

getExpandoColumn

public static ExpandoColumn getExpandoColumn(long columnId)
                                      throws PortalException,
                                             SystemException

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

SystemException - if a system exception occurred

getPersistedModel

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

Throws:

PortalException

SystemException

getExpandoColumns

public static List<ExpandoColumn> getExpandoColumns(int start,
                                                    int end)
                                             throws SystemException

Returns a range of all the expando columns.

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.

Parameters:

start - the lower bound of the range of expando columns

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

Returns:

the range of expando columns

Throws:

SystemException - if a system exception occurred

getExpandoColumnsCount

public static int getExpandoColumnsCount()
                                  throws SystemException

Returns the number of expando columns.

Returns:

the number of expando columns

Throws:

SystemException - if a system exception occurred

updateExpandoColumn

public static ExpandoColumn updateExpandoColumn(ExpandoColumn expandoColumn)
                                         throws SystemException

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

Parameters:

expandoColumn - the expando column

Returns:

the expando column that was updated

Throws:

SystemException - if a system exception occurred

updateExpandoColumn

public static ExpandoColumn updateExpandoColumn(ExpandoColumn expandoColumn,
                                                boolean merge)
                                         throws SystemException

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

Parameters:

expandoColumn - the expando column

merge - whether to merge the expando column with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the expando column 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

addColumn

public static ExpandoColumn addColumn(long tableId,
                                      String name,
                                      int type)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

addColumn

public static ExpandoColumn addColumn(long tableId,
                                      String name,
                                      int type,
                                      Object defaultData)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

deleteColumn

public static void deleteColumn(ExpandoColumn column)
                         throws SystemException

Throws:

SystemException

deleteColumn

public static void deleteColumn(long columnId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

deleteColumn

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

Throws:

PortalException

SystemException

deleteColumn

public static void deleteColumn(long tableId,
                                String name)
                         throws SystemException

Throws:

SystemException

deleteColumn

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

Throws:

PortalException

SystemException

deleteColumns

public static void deleteColumns(long tableId)
                          throws SystemException

Throws:

SystemException

deleteColumns

public static void deleteColumns(long companyId,
                                 long classNameId,
                                 String tableName)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

deleteColumns

public static void deleteColumns(long companyId,
                                 String className,
                                 String tableName)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getColumn

public static ExpandoColumn getColumn(long columnId)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getColumn

public static ExpandoColumn getColumn(long companyId,
                                      long classNameId,
                                      String tableName,
                                      String name)
                               throws SystemException

Throws:

SystemException

getColumn

public static ExpandoColumn getColumn(long tableId,
                                      String name)
                               throws SystemException

Throws:

SystemException

getColumn

public static ExpandoColumn getColumn(long companyId,
                                      String className,
                                      String tableName,
                                      String name)
                               throws SystemException

Throws:

SystemException

getColumns

public static List<ExpandoColumn> getColumns(long tableId)
                                      throws SystemException

Throws:

SystemException

getColumns

public static List<ExpandoColumn> getColumns(long tableId,
                                             Collection<String> names)
                                      throws SystemException

Throws:

SystemException

getColumns

public static List<ExpandoColumn> getColumns(long companyId,
                                             long classNameId,
                                             String tableName)
                                      throws SystemException

Throws:

SystemException

getColumns

public static List<ExpandoColumn> getColumns(long companyId,
                                             long classNameId,
                                             String tableName,
                                             Collection<String> names)
                                      throws SystemException

Throws:

SystemException

getColumns

public static List<ExpandoColumn> getColumns(long companyId,
                                             String className,
                                             String tableName)
                                      throws SystemException

Throws:

SystemException

getColumns

public static List<ExpandoColumn> getColumns(long companyId,
                                             String className,
                                             String tableName,
                                             Collection<String> columnNames)
                                      throws SystemException

Throws:

SystemException

getColumnsCount

public static int getColumnsCount(long tableId)
                           throws SystemException

Throws:

SystemException

getColumnsCount

public static int getColumnsCount(long companyId,
                                  long classNameId,
                                  String tableName)
                           throws SystemException

Throws:

SystemException

getColumnsCount

public static int getColumnsCount(long companyId,
                                  String className,
                                  String tableName)
                           throws SystemException

Throws:

SystemException

getDefaultTableColumn

public static ExpandoColumn getDefaultTableColumn(long companyId,
                                                  long classNameId,
                                                  String name)
                                           throws SystemException

Throws:

SystemException

getDefaultTableColumn

public static ExpandoColumn getDefaultTableColumn(long companyId,
                                                  String className,
                                                  String name)
                                           throws SystemException

Throws:

SystemException

getDefaultTableColumns

public static List<ExpandoColumn> getDefaultTableColumns(long companyId,
                                                         long classNameId)
                                                  throws SystemException

Throws:

SystemException

getDefaultTableColumns

public static List<ExpandoColumn> getDefaultTableColumns(long companyId,
                                                         String className)
                                                  throws SystemException

Throws:

SystemException

getDefaultTableColumnsCount

public static int getDefaultTableColumnsCount(long companyId,
                                              long classNameId)
                                       throws SystemException

Throws:

SystemException

getDefaultTableColumnsCount

public static int getDefaultTableColumnsCount(long companyId,
                                              String className)
                                       throws SystemException

Throws:

SystemException

updateColumn

public static ExpandoColumn updateColumn(long columnId,
                                         String name,
                                         int type)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

updateColumn

public static ExpandoColumn updateColumn(long columnId,
                                         String name,
                                         int type,
                                         Object defaultData)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

updateTypeSettings

public static ExpandoColumn updateTypeSettings(long columnId,
                                               String typeSettings)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getService

public static ExpandoColumnLocalService getService()

setService

public void setService(ExpandoColumnLocalService service)

Deprecated.