Liferay 6.2-ce-ga5

com.liferay.portlet.expando.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.

See Also:
ExpandoRowLocalServiceUtil, com.liferay.portlet.expando.service.base.ExpandoRowLocalServiceBaseImpl, com.liferay.portlet.expando.service.impl.ExpandoRowLocalServiceImpl

Method Summary
 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.
 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()
           
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 ExpandoRow fetchExpandoRow(long rowId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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.
 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)
           
 List<ExpandoRow> getRows(String className, String tableName, int start, int end)
          Deprecated. As of 6.1.0, replaced by getRows(long, String, String, int, int)
 int getRowsCount(long tableId)
           
 int getRowsCount(long companyId, long classNameId, String tableName)
           
 int getRowsCount(long companyId, String className, String tableName)
           
 int getRowsCount(String className, String tableName)
          Deprecated. As of 6.1.0, replaced by getRowsCount(long, String, String)
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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)
                         throws SystemException
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
Throws:
SystemException - if a system exception occurred

createExpandoRow

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(long rowId)
                            throws PortalException,
                                   SystemException
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
SystemException - if a system exception occurred

deleteExpandoRow

@Indexable(type=DELETE)
ExpandoRow deleteExpandoRow(ExpandoRow expandoRow)
                            throws SystemException
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
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. 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
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. 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
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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchExpandoRow

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoRow fetchExpandoRow(long rowId)
                           throws SystemException
Throws:
SystemException

getExpandoRow

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoRow getExpandoRow(long rowId)
                         throws PortalException,
                                SystemException
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
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

getExpandoRows

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoRow> getExpandoRows(int start,
                                                                         int end)
                                throws SystemException
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
Throws:
SystemException - if a system exception occurred

getExpandoRowsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getExpandoRowsCount()
                        throws SystemException
Returns the number of expando rows.

Returns:
the number of expando rows
Throws:
SystemException - if a system exception occurred

updateExpandoRow

@Indexable(type=REINDEX)
ExpandoRow updateExpandoRow(ExpandoRow expandoRow)
                            throws SystemException
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
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

addRow

ExpandoRow addRow(long tableId,
                  long classPK)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

deleteRow

void deleteRow(ExpandoRow row)
               throws SystemException
Throws:
SystemException

deleteRow

void deleteRow(long rowId)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

deleteRow

void deleteRow(long tableId,
               long classPK)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

deleteRow

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

deleteRow

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

deleteRows

void deleteRows(long classPK)
                throws SystemException
Throws:
SystemException

getDefaultTableRows

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

getDefaultTableRows

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

getDefaultTableRowsCount

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

getDefaultTableRowsCount

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

getRow

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

getRow

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

getRow

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

getRow

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

getRows

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

getRows

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

getRows

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

getRows

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoRow> getRows(String className,
                                                                  String tableName,
                                                                  int start,
                                                                  int end)
                         throws SystemException
Deprecated. As of 6.1.0, replaced by getRows(long, String, String, int, int)

Throws:
SystemException

getRowsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRowsCount(long tableId)
                 throws SystemException
Throws:
SystemException

getRowsCount

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

getRowsCount

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

getRowsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRowsCount(String className,
                                                          String tableName)
                 throws SystemException
Deprecated. As of 6.1.0, replaced by getRowsCount(long, String, String)

Throws:
SystemException

Liferay 6.2-ce-ga5