Class ExpandoTableLocalServiceUtil

Object
com.liferay.expando.kernel.service.ExpandoTableLocalServiceUtil

public class ExpandoTableLocalServiceUtil extends Object
Provides the local service utility for ExpandoTable. This utility wraps com.liferay.portlet.expando.service.impl.ExpandoTableLocalServiceImpl 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:
{$generated.description}
  • Constructor Details

    • ExpandoTableLocalServiceUtil

      public ExpandoTableLocalServiceUtil()
  • Method Details

    • addDefaultTable

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

      public static ExpandoTable addDefaultTable(long companyId, String className) throws PortalException
      Throws:
      PortalException
    • addExpandoTable

      public static ExpandoTable addExpandoTable(ExpandoTable expandoTable)
      Adds the expando table to the database. Also notifies the appropriate model listeners.

      Important: Inspect ExpandoTableLocalServiceImpl 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:
      expandoTable - the expando table
      Returns:
      the expando table that was added
    • addTable

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

      public static ExpandoTable addTable(long companyId, String className, String name) throws PortalException
      Throws:
      PortalException
    • createExpandoTable

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

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • deleteExpandoTable

      public static ExpandoTable deleteExpandoTable(ExpandoTable expandoTable) throws PortalException
      Deletes the expando table from the database. Also notifies the appropriate model listeners.

      Important: Inspect ExpandoTableLocalServiceImpl 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:
      expandoTable - the expando table
      Returns:
      the expando table that was removed
      Throws:
      PortalException
    • deleteExpandoTable

      public static ExpandoTable deleteExpandoTable(long tableId) throws PortalException
      Deletes the expando table with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect ExpandoTableLocalServiceImpl 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:
      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

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deleteTable

      public static void deleteTable(ExpandoTable table) throws PortalException
      Throws:
      PortalException
    • deleteTable

      public static void deleteTable(long tableId) throws PortalException
      Throws:
      PortalException
    • deleteTable

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

      public static void deleteTable(long companyId, String className, String name) throws PortalException
      Throws:
      PortalException
    • deleteTables

      public static void deleteTables(long companyId, long classNameId) throws PortalException
      Throws:
      PortalException
    • deleteTables

      public static void deleteTables(long companyId, String className) throws PortalException
      Throws:
      PortalException
    • 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.ExpandoTableModelImpl.

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

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

      public static ExpandoTable fetchDefaultTable(long companyId, long classNameId)
    • fetchDefaultTable

      public static ExpandoTable fetchDefaultTable(long companyId, String className)
    • fetchExpandoTable

      public static ExpandoTable fetchExpandoTable(long tableId)
    • fetchTable

      public static ExpandoTable fetchTable(long companyId, long classNameId, String name)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getDefaultTable

      public static ExpandoTable getDefaultTable(long companyId, long classNameId) throws PortalException
      Throws:
      PortalException
    • getDefaultTable

      public static ExpandoTable getDefaultTable(long companyId, String className) throws PortalException
      Throws:
      PortalException
    • getExpandoTable

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

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

      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

      public static int getExpandoTablesCount()
      Returns the number of expando tables.
      Returns:
      the number of expando tables
    • 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
    • getTable

      public static ExpandoTable getTable(long tableId) throws PortalException
      Throws:
      PortalException
    • getTable

      public static ExpandoTable getTable(long companyId, long classNameId, String name) throws PortalException
      Throws:
      PortalException
    • getTable

      public static ExpandoTable getTable(long companyId, String className, String name) throws PortalException
      Throws:
      PortalException
    • getTables

      public static List<ExpandoTable> getTables(long companyId, long classNameId)
    • getTables

      public static List<ExpandoTable> getTables(long companyId, String className)
    • updateExpandoTable

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

      Important: Inspect ExpandoTableLocalServiceImpl 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:
      expandoTable - the expando table
      Returns:
      the expando table that was updated
    • updateTable

      public static ExpandoTable updateTable(long tableId, String name) throws PortalException
      Throws:
      PortalException
    • getService

      public static ExpandoTableLocalService getService()
    • setService

      public static void setService(ExpandoTableLocalService service)