com.liferay.expando.kernel.service

Class ExpandoRowLocalServiceUtil

Object

com.liferay.expando.kernel.service.ExpandoRowLocalServiceUtil

public class ExpandoRowLocalServiceUtil
extends Object

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

Author:

Brian Wing Shun Chan

See Also:

ExpandoRowLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
ExpandoRowLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static ExpandoRow	addExpandoRow(ExpandoRow expandoRow) Adds the expando row to the database.
static ExpandoRow	addRow(long tableId, long classPK)
static ExpandoRow	createExpandoRow(long rowId) Creates a new expando row with the primary key.
static PersistedModel	createPersistedModel(Serializable primaryKeyObj)
static ExpandoRow	deleteExpandoRow(ExpandoRow expandoRow) Deletes the expando row from the database.
static ExpandoRow	deleteExpandoRow(long rowId) Deletes the expando row with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static void	deleteRow(ExpandoRow row)
static void	deleteRow(long rowId)
static void	deleteRow(long tableId, long classPK)
static void	deleteRow(long companyId, long classNameId, String tableName, long classPK)
static void	deleteRow(long companyId, String className, String tableName, long classPK)
static void	deleteRows(long classPK)
static void	deleteRows(long companyId, long classNameId, long classPK)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <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.
static <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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static ExpandoRow	fetchExpandoRow(long rowId)
static ExpandoRow	fetchRow(long tableId, long classPK)
static ActionableDynamicQuery	getActionableDynamicQuery()
static List<ExpandoRow>	getDefaultTableRows(long companyId, long classNameId, int start, int end)
static List<ExpandoRow>	getDefaultTableRows(long companyId, String className, int start, int end)
static int	getDefaultTableRowsCount(long companyId, long classNameId)
static int	getDefaultTableRowsCount(long companyId, String className)
static ExpandoRow	getExpandoRow(long rowId) Returns the expando row with the primary key.
static List<ExpandoRow>	getExpandoRows(int start, int end) Returns a range of all the expando rows.
static int	getExpandoRowsCount() Returns the number of expando rows.
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static ExpandoRow	getRow(long rowId)
static ExpandoRow	getRow(long tableId, long classPK)
static ExpandoRow	getRow(long companyId, long classNameId, String tableName, long classPK)
static ExpandoRow	getRow(long companyId, String className, String tableName, long classPK)
static List<ExpandoRow>	getRows(long tableId, int start, int end)
static List<ExpandoRow>	getRows(long companyId, long classNameId, String tableName, int start, int end)
static List<ExpandoRow>	getRows(long companyId, String className, String tableName, int start, int end)
static int	getRowsCount(long tableId)
static int	getRowsCount(long companyId, long classNameId, String tableName)
static int	getRowsCount(long companyId, String className, String tableName)
static ExpandoRowLocalService	getService()
static ExpandoRow	updateExpandoRow(ExpandoRow expandoRow) Updates the expando row in the database or adds it if it does not yet exist.

Methods inherited from class Object

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

Constructor Detail

ExpandoRowLocalServiceUtil

public ExpandoRowLocalServiceUtil()

Method Detail

addExpandoRow

public static ExpandoRow addExpandoRow(ExpandoRow expandoRow)

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

Important: Inspect ExpandoRowLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

expandoRow - the expando row

Returns:

the expando row that was added

addRow

public static ExpandoRow addRow(long tableId,
                                long classPK)
                         throws PortalException

Throws:

PortalException

createExpandoRow

public static 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

createPersistedModel

public static PersistedModel createPersistedModel(Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

deleteExpandoRow

public static ExpandoRow deleteExpandoRow(ExpandoRow expandoRow)

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

Important: Inspect ExpandoRowLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

expandoRow - the expando row

Returns:

the expando row that was removed

deleteExpandoRow

public static ExpandoRow deleteExpandoRow(long rowId)
                                   throws PortalException

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

Important: Inspect ExpandoRowLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

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

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteRow

public static void deleteRow(ExpandoRow row)

deleteRow

public static void deleteRow(long rowId)
                      throws PortalException

Throws:

PortalException

deleteRow

public static void deleteRow(long tableId,
                             long classPK)
                      throws PortalException

Throws:

PortalException

deleteRow

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

Throws:

PortalException

deleteRow

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

Throws:

PortalException

deleteRows

public static void deleteRows(long classPK)

deleteRows

public static void deleteRows(long companyId,
                              long classNameId,
                              long classPK)

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public static <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, then the query will include the default ORDER BY logic from com.liferay.portlet.expando.model.impl.ExpandoRowModelImpl.

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

public static <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, then the query will include the default ORDER BY logic from com.liferay.portlet.expando.model.impl.ExpandoRowModelImpl.

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

public static 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

public static 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

public static ExpandoRow fetchExpandoRow(long rowId)

fetchRow

public static ExpandoRow fetchRow(long tableId,
                                  long classPK)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDefaultTableRows

public static List<ExpandoRow> getDefaultTableRows(long companyId,
                                                   long classNameId,
                                                   int start,
                                                   int end)

getDefaultTableRows

public static List<ExpandoRow> getDefaultTableRows(long companyId,
                                                   String className,
                                                   int start,
                                                   int end)

getDefaultTableRowsCount

public static int getDefaultTableRowsCount(long companyId,
                                           long classNameId)

getDefaultTableRowsCount

public static int getDefaultTableRowsCount(long companyId,
                                           String className)

getExpandoRow

public static 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

public static 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 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, then the query will include the default ORDER BY logic from com.liferay.portlet.expando.model.impl.ExpandoRowModelImpl.

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

public static int getExpandoRowsCount()

Returns the number of expando rows.

Returns:

the number of expando rows

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getRow

public static ExpandoRow getRow(long rowId)
                         throws PortalException

Throws:

PortalException

getRow

public static ExpandoRow getRow(long tableId,
                                long classPK)
                         throws PortalException

Throws:

PortalException

getRow

public static ExpandoRow getRow(long companyId,
                                long classNameId,
                                String tableName,
                                long classPK)

getRow

public static ExpandoRow getRow(long companyId,
                                String className,
                                String tableName,
                                long classPK)

getRows

public static List<ExpandoRow> getRows(long tableId,
                                       int start,
                                       int end)

getRows

public static List<ExpandoRow> getRows(long companyId,
                                       long classNameId,
                                       String tableName,
                                       int start,
                                       int end)

getRows

public static List<ExpandoRow> getRows(long companyId,
                                       String className,
                                       String tableName,
                                       int start,
                                       int end)

getRowsCount

public static int getRowsCount(long tableId)

getRowsCount

public static int getRowsCount(long companyId,
                               long classNameId,
                               String tableName)

getRowsCount

public static int getRowsCount(long companyId,
                               String className,
                               String tableName)

updateExpandoRow

public static 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.

Important: Inspect ExpandoRowLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

expandoRow - the expando row

Returns:

the expando row that was updated

getService

public static ExpandoRowLocalService getService()