Liferay 6.2-ce-ga5

com.liferay.portlet.expando.service
Interface ExpandoTableLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ExpandoTableLocalServiceWrapper

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

Provides the local service interface for ExpandoTable. 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:
ExpandoTableLocalServiceUtil, com.liferay.portlet.expando.service.base.ExpandoTableLocalServiceBaseImpl, com.liferay.portlet.expando.service.impl.ExpandoTableLocalServiceImpl

Method Summary
 ExpandoTable addDefaultTable(long companyId, long classNameId)
           
 ExpandoTable addDefaultTable(long companyId, String className)
           
 ExpandoTable addExpandoTable(ExpandoTable expandoTable)
          Adds the expando table to the database.
 ExpandoTable addTable(long companyId, long classNameId, String name)
           
 ExpandoTable addTable(long classNameId, String name)
          Deprecated. As of 6.1.0, replaced by addTable(long, long, String)
 ExpandoTable addTable(long companyId, String className, String name)
           
 ExpandoTable addTable(String className, String name)
          Deprecated. As of 6.1.0, replaced by addTable(long, String, String)
 ExpandoTable createExpandoTable(long tableId)
          Creates a new expando table with the primary key.
 ExpandoTable deleteExpandoTable(ExpandoTable expandoTable)
          Deletes the expando table from the database.
 ExpandoTable deleteExpandoTable(long tableId)
          Deletes the expando table with the primary key from the database.
 void deleteTable(ExpandoTable table)
           
 void deleteTable(long tableId)
           
 void deleteTable(long companyId, long classNameId, String name)
           
 void deleteTable(long companyId, String className, String name)
           
 void deleteTables(long companyId, long classNameId)
           
 void deleteTables(long companyId, String className)
           
 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.
 ExpandoTable fetchDefaultTable(long companyId, long classNameId)
           
 ExpandoTable fetchDefaultTable(long companyId, String className)
           
 ExpandoTable fetchExpandoTable(long tableId)
           
 ExpandoTable fetchTable(long companyId, long classNameId, String name)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 ExpandoTable getDefaultTable(long companyId, long classNameId)
           
 ExpandoTable getDefaultTable(long companyId, String className)
           
 ExpandoTable getExpandoTable(long tableId)
          Returns the expando table with the primary key.
 List<ExpandoTable> getExpandoTables(int start, int end)
          Returns a range of all the expando tables.
 int getExpandoTablesCount()
          Returns the number of expando tables.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 ExpandoTable getTable(long tableId)
           
 ExpandoTable getTable(long companyId, long classNameId, String name)
           
 ExpandoTable getTable(long classNameId, String name)
          Deprecated. As of 6.1.0, replaced by getTable(long, long, String)
 ExpandoTable getTable(long companyId, String className, String name)
           
 ExpandoTable getTable(String className, String name)
          Deprecated. As of 6.1.0, replaced by getTable(long, String, String)
 List<ExpandoTable> getTables(long companyId, long classNameId)
           
 List<ExpandoTable> getTables(long companyId, String className)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 ExpandoTable updateExpandoTable(ExpandoTable expandoTable)
          Updates the expando table in the database or adds it if it does not yet exist.
 ExpandoTable updateTable(long tableId, String name)
           
 

Method Detail

addExpandoTable

@Indexable(type=REINDEX)
ExpandoTable addExpandoTable(ExpandoTable expandoTable)
                             throws SystemException
Adds the expando table to the database. Also notifies the appropriate model listeners.

Parameters:
expandoTable - the expando table
Returns:
the expando table that was added
Throws:
SystemException - if a system exception occurred

createExpandoTable

ExpandoTable createExpandoTable(long tableId)
Creates a new expando table with the primary key. Does not add the expando table to the database.

Parameters:
tableId - the primary key for the new expando table
Returns:
the new expando table

deleteExpandoTable

@Indexable(type=DELETE)
ExpandoTable deleteExpandoTable(long tableId)
                                throws PortalException,
                                       SystemException
Deletes the expando table with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
tableId - the primary key of the expando table
Returns:
the expando table that was removed
Throws:
PortalException - if a expando table with the primary key could not be found
SystemException - if a system exception occurred

deleteExpandoTable

@Indexable(type=DELETE)
ExpandoTable deleteExpandoTable(ExpandoTable expandoTable)
                                throws SystemException
Deletes the expando table from the database. Also notifies the appropriate model listeners.

Parameters:
expandoTable - the expando table
Returns:
the expando table 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 ExpandoTableModelImpl. 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 ExpandoTableModelImpl. 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

fetchExpandoTable

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

getExpandoTable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoTable getExpandoTable(long tableId)
                             throws PortalException,
                                    SystemException
Returns the expando table with the primary key.

Parameters:
tableId - the primary key of the expando table
Returns:
the expando table
Throws:
PortalException - if a expando table 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

getExpandoTables

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoTable> getExpandoTables(int start,
                                                                             int end)
                                    throws SystemException
Returns a range of all the expando tables.

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 ExpandoTableModelImpl. 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 tables
end - the upper bound of the range of expando tables (not inclusive)
Returns:
the range of expando tables
Throws:
SystemException - if a system exception occurred

getExpandoTablesCount

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

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

updateExpandoTable

@Indexable(type=REINDEX)
ExpandoTable updateExpandoTable(ExpandoTable expandoTable)
                                throws SystemException
Updates the expando table in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
expandoTable - the expando table
Returns:
the expando table 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

addDefaultTable

ExpandoTable addDefaultTable(long companyId,
                             long classNameId)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

addDefaultTable

ExpandoTable addDefaultTable(long companyId,
                             String className)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

addTable

ExpandoTable addTable(long companyId,
                      long classNameId,
                      String name)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

addTable

ExpandoTable addTable(long classNameId,
                      String name)
                      throws PortalException,
                             SystemException
Deprecated. As of 6.1.0, replaced by addTable(long, long, String)

Throws:
PortalException
SystemException

addTable

ExpandoTable addTable(long companyId,
                      String className,
                      String name)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

addTable

ExpandoTable addTable(String className,
                      String name)
                      throws PortalException,
                             SystemException
Deprecated. As of 6.1.0, replaced by addTable(long, String, String)

Throws:
PortalException
SystemException

deleteTable

void deleteTable(ExpandoTable table)
                 throws SystemException
Throws:
SystemException

deleteTable

void deleteTable(long tableId)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

deleteTable

void deleteTable(long companyId,
                 long classNameId,
                 String name)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

deleteTable

void deleteTable(long companyId,
                 String className,
                 String name)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

deleteTables

void deleteTables(long companyId,
                  long classNameId)
                  throws SystemException
Throws:
SystemException

deleteTables

void deleteTables(long companyId,
                  String className)
                  throws SystemException
Throws:
SystemException

fetchDefaultTable

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

fetchDefaultTable

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

fetchTable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoTable fetchTable(long companyId,
                                                                 long classNameId,
                                                                 String name)
                        throws SystemException
Throws:
SystemException

getDefaultTable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoTable getDefaultTable(long companyId,
                                                                      long classNameId)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

getDefaultTable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoTable getDefaultTable(long companyId,
                                                                      String className)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

getTable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoTable getTable(long tableId)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getTable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoTable getTable(long companyId,
                                                               long classNameId,
                                                               String name)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getTable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoTable getTable(long classNameId,
                                                               String name)
                      throws PortalException,
                             SystemException
Deprecated. As of 6.1.0, replaced by getTable(long, long, String)

Throws:
PortalException
SystemException

getTable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoTable getTable(long companyId,
                                                               String className,
                                                               String name)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getTable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoTable getTable(String className,
                                                               String name)
                      throws PortalException,
                             SystemException
Deprecated. As of 6.1.0, replaced by getTable(long, String, String)

Throws:
PortalException
SystemException

getTables

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoTable> getTables(long companyId,
                                                                      long classNameId)
                             throws SystemException
Throws:
SystemException

getTables

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoTable> getTables(long companyId,
                                                                      String className)
                             throws SystemException
Throws:
SystemException

updateTable

ExpandoTable updateTable(long tableId,
                         String name)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5