com.liferay.expando.kernel.service

Interface ExpandoColumnLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

ExpandoColumnLocalServiceWrapper

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

Provides the local service interface for ExpandoColumn. 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:

ExpandoColumnLocalServiceUtil

{$generated.description}

Method Summary

Modifier and Type	Method and Description
ExpandoColumn	addColumn(long tableId, String name, int type) NOTE FOR DEVELOPERS: Never modify or reference this interface directly.
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.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<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.
ExpandoColumn	fetchExpandoColumn(long columnId)
ActionableDynamicQuery	getActionableDynamicQuery()
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.
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
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	updateTypeSettings(long columnId, String typeSettings)

Method Detail

addColumn

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

NOTE FOR DEVELOPERS: Never modify or reference this interface directly. Always use ExpandoColumnLocalServiceUtil to access the expando column local service. Add custom service methods to com.liferay.portlet.expando.service.impl.ExpandoColumnLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

Throws:

PortalException

addColumn

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

Throws:

PortalException

addExpandoColumn

@Indexable(type=REINDEX)
ExpandoColumn addExpandoColumn(ExpandoColumn expandoColumn)

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

createExpandoColumn

@Transactional(enabled=false)
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

deleteColumn

void deleteColumn(ExpandoColumn column)

deleteColumn

void deleteColumn(long columnId)
           throws PortalException

Throws:

PortalException

deleteColumn

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

Throws:

PortalException

deleteColumn

void deleteColumn(long tableId,
                  String name)

deleteColumn

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

Throws:

PortalException

deleteColumns

void deleteColumns(long tableId)

deleteColumns

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

Throws:

PortalException

deleteColumns

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

Throws:

PortalException

deleteExpandoColumn

@Indexable(type=DELETE)
ExpandoColumn deleteExpandoColumn(ExpandoColumn expandoColumn)

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

deleteExpandoColumn

@Indexable(type=DELETE)
ExpandoColumn deleteExpandoColumn(long columnId)
                                                   throws PortalException

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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery 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 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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.expando.model.impl.ExpandoColumnModelImpl. 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

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 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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.expando.model.impl.ExpandoColumnModelImpl. 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

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 query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchExpandoColumn

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

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getColumn

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

Throws:

PortalException

getColumn

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

getColumn

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

getColumn

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

getColumns

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

getColumns

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

getColumns

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

getColumns

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

getColumns

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

getColumns

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

getColumnsCount

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

getColumnsCount

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

getColumnsCount

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

getDefaultTableColumn

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

getDefaultTableColumn

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

getDefaultTableColumns

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

getDefaultTableColumns

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

getDefaultTableColumnsCount

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

getDefaultTableColumnsCount

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

getExpandoColumn

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

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

getExpandoColumns

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoColumn> getExpandoColumns(int start,
                                                                                                         int end)

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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.expando.model.impl.ExpandoColumnModelImpl. 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 columns

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

Returns:

the range of expando columns

getExpandoColumnsCount

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

Returns the number of expando columns.

Returns:

the number of expando columns

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 interface PersistedModelLocalService

Throws:

PortalException

updateColumn

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

Throws:

PortalException

updateColumn

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

Throws:

PortalException

updateExpandoColumn

@Indexable(type=REINDEX)
ExpandoColumn updateExpandoColumn(ExpandoColumn expandoColumn)

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

updateTypeSettings

ExpandoColumn updateTypeSettings(long columnId,
                                 String typeSettings)
                          throws PortalException

Throws:

PortalException