com.liferay.expando.kernel.service

Interface ExpandoRowLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

ExpandoRowLocalServiceWrapper

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

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

ExpandoRowLocalServiceUtil, ExpandoRowLocalServiceBaseImpl, ExpandoRowLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
ExpandoRow	addExpandoRow(ExpandoRow expandoRow) Adds the expando row to the database.
ExpandoRow	addRow(long tableId, long classPK)
ExpandoRow	createExpandoRow(long rowId) Creates a new expando row with the primary key.
ExpandoRow	deleteExpandoRow(ExpandoRow expandoRow) Deletes the expando row from the database.
ExpandoRow	deleteExpandoRow(long rowId) Deletes the expando row with the primary key from the database.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
void	deleteRow(ExpandoRow row)
void	deleteRow(long rowId)
void	deleteRow(long tableId, long classPK)
void	deleteRow(long companyId, long classNameId, String tableName, long classPK)
void	deleteRow(long companyId, String className, String tableName, long classPK)
void	deleteRows(long classPK)
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.
ExpandoRow	fetchExpandoRow(long rowId)
ExpandoRow	fetchRow(long tableId, long classPK)
ActionableDynamicQuery	getActionableDynamicQuery()
List<ExpandoRow>	getDefaultTableRows(long companyId, long classNameId, int start, int end)
List<ExpandoRow>	getDefaultTableRows(long companyId, String className, int start, int end)
int	getDefaultTableRowsCount(long companyId, long classNameId)
int	getDefaultTableRowsCount(long companyId, String className)
ExpandoRow	getExpandoRow(long rowId) Returns the expando row with the primary key.
List<ExpandoRow>	getExpandoRows(int start, int end) Returns a range of all the expando rows.
int	getExpandoRowsCount() Returns the number of expando rows.
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
ExpandoRow	getRow(long rowId)
ExpandoRow	getRow(long tableId, long classPK)
ExpandoRow	getRow(long companyId, long classNameId, String tableName, long classPK)
ExpandoRow	getRow(long companyId, String className, String tableName, long classPK)
List<ExpandoRow>	getRows(long tableId, int start, int end)
List<ExpandoRow>	getRows(long companyId, long classNameId, String tableName, int start, int end)
List<ExpandoRow>	getRows(long companyId, String className, String tableName, int start, int end)
int	getRowsCount(long tableId)
int	getRowsCount(long companyId, long classNameId, String tableName)
int	getRowsCount(long companyId, String className, String tableName)
ExpandoRow	updateExpandoRow(ExpandoRow expandoRow) Updates the expando row in the database or adds it if it does not yet exist.

Method Detail

addExpandoRow

@Indexable(type=REINDEX)
ExpandoRow addExpandoRow(ExpandoRow expandoRow)

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

Parameters:

expandoRow - the expando row

Returns:

the expando row that was added

addRow

ExpandoRow addRow(long tableId,
                  long classPK)
           throws PortalException

Throws:

PortalException

createExpandoRow

@Transactional(enabled=false)
ExpandoRow createExpandoRow(long rowId)

Creates a new expando row with the primary key. Does not add the expando row to the database.

Parameters:

rowId - the primary key for the new expando row

Returns:

the new expando row

deleteExpandoRow

@Indexable(type=DELETE)
ExpandoRow deleteExpandoRow(ExpandoRow expandoRow)

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

Parameters:

expandoRow - the expando row

Returns:

the expando row that was removed

deleteExpandoRow

@Indexable(type=DELETE)
ExpandoRow deleteExpandoRow(long rowId)
                                             throws PortalException

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

Parameters:

rowId - the primary key of the expando row

Returns:

the expando row that was removed

Throws:

PortalException - if a expando row with the primary key could not be found

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteRow

void deleteRow(ExpandoRow row)

deleteRow

void deleteRow(long rowId)
        throws PortalException

Throws:

PortalException

deleteRow

void deleteRow(long tableId,
               long classPK)
        throws PortalException

Throws:

PortalException

deleteRow

void deleteRow(long companyId,
               long classNameId,
               String tableName,
               long classPK)
        throws PortalException

Throws:

PortalException

deleteRow

void deleteRow(long companyId,
               String className,
               String tableName,
               long classPK)
        throws PortalException

Throws:

PortalException

deleteRows

void deleteRows(long classPK)

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<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

<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 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 ExpandoRowModelImpl. 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

<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 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 ExpandoRowModelImpl. 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

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

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

fetchExpandoRow

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoRow fetchExpandoRow(long rowId)

fetchRow

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoRow fetchRow(long tableId,
                                                                                       long classPK)

getActionableDynamicQuery

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

getDefaultTableRows

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoRow> getDefaultTableRows(long companyId,
                                                                                                        long classNameId,
                                                                                                        int start,
                                                                                                        int end)

getDefaultTableRows

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoRow> getDefaultTableRows(long companyId,
                                                                                                        String className,
                                                                                                        int start,
                                                                                                        int end)

getDefaultTableRowsCount

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

getDefaultTableRowsCount

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

getExpandoRow

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoRow getExpandoRow(long rowId)
                                                                                     throws PortalException

Returns the expando row with the primary key.

Parameters:

rowId - the primary key of the expando row

Returns:

the expando row

Throws:

PortalException - if a expando row with the primary key could not be found

getExpandoRows

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

Returns a range of all the expando 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 ExpandoRowModelImpl. 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 rows

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

Returns:

the range of expando rows

getExpandoRowsCount

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

Returns the number of expando rows.

Returns:

the number of expando rows

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

getRow

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoRow getRow(long rowId)
                                                                              throws PortalException

Throws:

PortalException

getRow

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoRow getRow(long tableId,
                                                                                     long classPK)
                                                                              throws PortalException

Throws:

PortalException

getRow

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoRow getRow(long companyId,
                                                                                     long classNameId,
                                                                                     String tableName,
                                                                                     long classPK)

getRow

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoRow getRow(long companyId,
                                                                                     String className,
                                                                                     String tableName,
                                                                                     long classPK)

getRows

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoRow> getRows(long tableId,
                                                                                            int start,
                                                                                            int end)

getRows

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoRow> getRows(long companyId,
                                                                                            long classNameId,
                                                                                            String tableName,
                                                                                            int start,
                                                                                            int end)

getRows

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoRow> getRows(long companyId,
                                                                                            String className,
                                                                                            String tableName,
                                                                                            int start,
                                                                                            int end)

getRowsCount

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

getRowsCount

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

getRowsCount

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

updateExpandoRow

@Indexable(type=REINDEX)
ExpandoRow updateExpandoRow(ExpandoRow expandoRow)

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

Parameters:

expandoRow - the expando row

Returns:

the expando row that was updated