Liferay 7.0-ce-b4

com.liferay.portlet.expando.service
Interface ExpandoTableLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ExpandoTableLocalServiceBaseImpl, ExpandoTableLocalServiceImpl, 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, ExpandoTableLocalServiceBaseImpl, ExpandoTableLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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 companyId, String className, String name)
           
 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.
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 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()
           
<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.
 ExpandoTable fetchDefaultTable(long companyId, long classNameId)
           
 ExpandoTable fetchDefaultTable(long companyId, String className)
           
 ExpandoTable fetchExpandoTable(long tableId)
           
 ExpandoTable fetchTable(long companyId, long classNameId, String name)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 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.
 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 ExpandoTable getTable(long tableId)
           
 ExpandoTable getTable(long companyId, long classNameId, String name)
           
 ExpandoTable getTable(long companyId, String className, String name)
           
 List<ExpandoTable> getTables(long companyId, long classNameId)
           
 List<ExpandoTable> getTables(long companyId, String className)
           
 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

addDefaultTable

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

addDefaultTable

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

addExpandoTable

@Indexable(type=REINDEX)
ExpandoTable addExpandoTable(ExpandoTable expandoTable)
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

addTable

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

addTable

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

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(ExpandoTable expandoTable)
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

deleteExpandoTable

@Indexable(type=DELETE)
ExpandoTable deleteExpandoTable(long tableId)
                                throws PortalException
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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

deleteTable

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

deleteTable

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

deleteTable

void deleteTable(ExpandoTable table)

deleteTable

void deleteTable(long tableId)
                 throws PortalException
Throws:
PortalException

deleteTables

void deleteTables(long companyId,
                  String className)

deleteTables

void deleteTables(long companyId,
                  long classNameId)

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

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

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

fetchDefaultTable

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

fetchDefaultTable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoTable fetchDefaultTable(long companyId,
                                                                        long classNameId)

fetchExpandoTable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoTable fetchExpandoTable(long tableId)

fetchTable

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

getActionableDynamicQuery

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

getDefaultTable

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

getDefaultTable

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

getExpandoTable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExpandoTable getExpandoTable(long tableId)
                             throws PortalException
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

getExpandoTables

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ExpandoTable> getExpandoTables(int start,
                                                                             int end)
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

getExpandoTablesCount

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

Returns:
the number of expando tables

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

getTable

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

getTable

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

getTable

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

getTables

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

getTables

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

updateExpandoTable

@Indexable(type=REINDEX)
ExpandoTable updateExpandoTable(ExpandoTable expandoTable)
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

updateTable

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

Liferay 7.0-ce-b4