com.liferay.portlet.expando.service
Interface ExpandoColumnLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

ExpandoColumnLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ExpandoColumnLocalService
extends BaseLocalService, PersistedModelLocalService

The interface for the expando column local service.

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:

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

Method Summary

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

Method Detail

addExpandoColumn

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

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoColumn fetchExpandoColumn(long columnId)
                                 throws SystemException

Throws:

SystemException

getExpandoColumn

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getExpandoColumns

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getExpandoColumnsCount()
                           throws SystemException

Returns the number of expando columns.

Returns:

the number of expando columns

Throws:

SystemException - if a system exception occurred

updateExpandoColumn

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

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

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addColumn

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

Throws:

PortalException

SystemException

addColumn

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

Throws:

PortalException

SystemException

deleteColumn

void deleteColumn(ExpandoColumn column)
                  throws SystemException

Throws:

SystemException

deleteColumn

void deleteColumn(long columnId)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

deleteColumn

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

Throws:

PortalException

SystemException

deleteColumn

void deleteColumn(long tableId,
                  String name)
                  throws SystemException

Throws:

SystemException

deleteColumn

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

Throws:

PortalException

SystemException

deleteColumns

void deleteColumns(long tableId)
                   throws SystemException

Throws:

SystemException

deleteColumns

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

Throws:

PortalException

SystemException

deleteColumns

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

Throws:

PortalException

SystemException

getColumn

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoColumn getColumn(long columnId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getColumn

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoColumn getColumn(long companyId,
                                                                 long classNameId,
                                                                 String tableName,
                                                                 String name)
                        throws SystemException

Throws:

SystemException

getColumn

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoColumn getColumn(long tableId,
                                                                 String name)
                        throws SystemException

Throws:

SystemException

getColumn

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoColumn getColumn(long companyId,
                                                                 String className,
                                                                 String tableName,
                                                                 String name)
                        throws SystemException

Throws:

SystemException

getColumns

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoColumn> getColumns(long tableId)
                               throws SystemException

Throws:

SystemException

getColumns

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoColumn> getColumns(long tableId,
                                                                        Collection<String> names)
                               throws SystemException

Throws:

SystemException

getColumns

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoColumn> getColumns(long companyId,
                                                                        long classNameId,
                                                                        String tableName)
                               throws SystemException

Throws:

SystemException

getColumns

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoColumn> getColumns(long companyId,
                                                                        long classNameId,
                                                                        String tableName,
                                                                        Collection<String> names)
                               throws SystemException

Throws:

SystemException

getColumns

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoColumn> getColumns(long companyId,
                                                                        String className,
                                                                        String tableName)
                               throws SystemException

Throws:

SystemException

getColumns

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoColumn> getColumns(long companyId,
                                                                        String className,
                                                                        String tableName,
                                                                        Collection<String> columnNames)
                               throws SystemException

Throws:

SystemException

getColumnsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getColumnsCount(long tableId)
                    throws SystemException

Throws:

SystemException

getColumnsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getColumnsCount(long companyId,
                                                             long classNameId,
                                                             String tableName)
                    throws SystemException

Throws:

SystemException

getColumnsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getColumnsCount(long companyId,
                                                             String className,
                                                             String tableName)
                    throws SystemException

Throws:

SystemException

getDefaultTableColumn

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoColumn getDefaultTableColumn(long companyId,
                                                                             long classNameId,
                                                                             String name)
                                    throws SystemException

Throws:

SystemException

getDefaultTableColumn

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoColumn getDefaultTableColumn(long companyId,
                                                                             String className,
                                                                             String name)
                                    throws SystemException

Throws:

SystemException

getDefaultTableColumns

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoColumn> getDefaultTableColumns(long companyId,
                                                                                    long classNameId)
                                           throws SystemException

Throws:

SystemException

getDefaultTableColumns

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoColumn> getDefaultTableColumns(long companyId,
                                                                                    String className)
                                           throws SystemException

Throws:

SystemException

getDefaultTableColumnsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDefaultTableColumnsCount(long companyId,
                                                                         long classNameId)
                                throws SystemException

Throws:

SystemException

getDefaultTableColumnsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDefaultTableColumnsCount(long companyId,
                                                                         String className)
                                throws SystemException

Throws:

SystemException

updateColumn

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

Throws:

PortalException

SystemException

updateColumn

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

Throws:

PortalException

SystemException

updateTypeSettings

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

Throws:

PortalException

SystemException