Class ExpandoColumnLocalServiceUtil
com.liferay.portlet.expando.service.impl.ExpandoColumnLocalServiceImpl
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ExpandoColumn
static ExpandoColumn
static ExpandoColumn
addExpandoColumn
(ExpandoColumn expandoColumn) Adds the expando column to the database.static ExpandoColumn
createExpandoColumn
(long columnId) Creates a new expando column with the primary key.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static void
deleteColumn
(long columnId) static void
deleteColumn
(long companyId, long classNameId, String tableName, String name) static void
deleteColumn
(long tableId, String name) static void
deleteColumn
(long companyId, String className, String tableName, String name) static void
deleteColumn
(ExpandoColumn column) static void
deleteColumns
(long tableId) static void
deleteColumns
(long companyId, long classNameId, String tableName) static void
deleteColumns
(long companyId, String className, String tableName) static ExpandoColumn
deleteExpandoColumn
(long columnId) Deletes the expando column with the primary key from the database.static ExpandoColumn
deleteExpandoColumn
(ExpandoColumn expandoColumn) Deletes the expando column from the database.static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) 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
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 ExpandoColumn
fetchColumn
(long companyId, long classNameId, String tableName, String name) static ExpandoColumn
fetchColumn
(long tableId, String name) static ExpandoColumn
fetchExpandoColumn
(long columnId) static ActionableDynamicQuery
static ExpandoColumn
getColumn
(long columnId) static ExpandoColumn
static ExpandoColumn
static ExpandoColumn
static List<ExpandoColumn>
getColumns
(long tableId) static List<ExpandoColumn>
getColumns
(long companyId, long classNameId, String tableName) static List<ExpandoColumn>
getColumns
(long companyId, long classNameId, String tableName, Collection<String> names) static List<ExpandoColumn>
getColumns
(long companyId, String className, String tableName) static List<ExpandoColumn>
getColumns
(long companyId, String className, String tableName, Collection<String> columnNames) static List<ExpandoColumn>
getColumns
(long tableId, Collection<String> names) static int
getColumnsCount
(long tableId) static int
getColumnsCount
(long companyId, long classNameId, String tableName) static int
getColumnsCount
(long companyId, String className, String tableName) static ExpandoColumn
getDefaultTableColumn
(long companyId, long classNameId, String name) static ExpandoColumn
getDefaultTableColumn
(long companyId, String className, String name) static List<ExpandoColumn>
getDefaultTableColumns
(long companyId, long classNameId) static List<ExpandoColumn>
getDefaultTableColumns
(long companyId, String className) static int
getDefaultTableColumnsCount
(long companyId, long classNameId) static int
getDefaultTableColumnsCount
(long companyId, String className) static ExpandoColumn
getExpandoColumn
(long columnId) Returns the expando column with the primary key.static List<ExpandoColumn>
getExpandoColumns
(int start, int end) Returns a range of all the expando columns.static int
Returns the number of expando columns.static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static ExpandoColumnLocalService
static void
setService
(ExpandoColumnLocalService service) static ExpandoColumn
updateColumn
(long columnId, String name, int type) static ExpandoColumn
updateColumn
(long columnId, String name, int type, Object defaultData) static ExpandoColumn
updateExpandoColumn
(ExpandoColumn expandoColumn) Updates the expando column in the database or adds it if it does not yet exist.static ExpandoColumn
updateTypeSettings
(long columnId, String typeSettings)
-
Constructor Details
-
ExpandoColumnLocalServiceUtil
public ExpandoColumnLocalServiceUtil()
-
-
Method Details
-
addColumn
- Throws:
PortalException
-
addColumn
public static ExpandoColumn addColumn(long tableId, String name, int type, Object defaultData) throws PortalException - Throws:
PortalException
-
addExpandoColumn
Adds the expando column to the database. Also notifies the appropriate model listeners.Important: Inspect ExpandoColumnLocalServiceImpl 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:
expandoColumn
- the expando column- Returns:
- the expando column that was added
-
createExpandoColumn
Creates a new expando column with the primary key. Does not add the expando column to the database.- Parameters:
columnId
- the primary key for the new expando column- Returns:
- the new expando column
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteColumn
- Throws:
PortalException
-
deleteColumn
- Throws:
PortalException
-
deleteColumn
public static void deleteColumn(long companyId, long classNameId, String tableName, String name) throws PortalException - Throws:
PortalException
-
deleteColumn
- Throws:
PortalException
-
deleteColumn
public static void deleteColumn(long companyId, String className, String tableName, String name) throws PortalException - Throws:
PortalException
-
deleteColumns
- Throws:
PortalException
-
deleteColumns
public static void deleteColumns(long companyId, long classNameId, String tableName) throws PortalException - Throws:
PortalException
-
deleteColumns
public static void deleteColumns(long companyId, String className, String tableName) throws PortalException - Throws:
PortalException
-
deleteExpandoColumn
Deletes the expando column from the database. Also notifies the appropriate model listeners.Important: Inspect ExpandoColumnLocalServiceImpl 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:
expandoColumn
- the expando column- Returns:
- the expando column that was removed
-
deleteExpandoColumn
Deletes the expando column with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect ExpandoColumnLocalServiceImpl 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:
columnId
- the primary key of the expando column- Returns:
- the expando column that was removed
- Throws:
PortalException
- if a expando column with the primary key could not be found
-
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) 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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.expando.model.impl.ExpandoColumnModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.expando.model.impl.ExpandoColumnModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchColumn
public static ExpandoColumn fetchColumn(long companyId, long classNameId, String tableName, String name) -
fetchColumn
-
fetchExpandoColumn
-
getActionableDynamicQuery
-
getColumn
- Throws:
PortalException
-
getColumn
public static ExpandoColumn getColumn(long companyId, long classNameId, String tableName, String name) throws PortalException - Throws:
PortalException
-
getColumn
- Throws:
PortalException
-
getColumn
public static ExpandoColumn getColumn(long companyId, String className, String tableName, String name) -
getColumns
-
getColumns
-
getColumns
-
getColumns
public static List<ExpandoColumn> getColumns(long companyId, long classNameId, String tableName, Collection<String> names) -
getColumns
-
getColumns
public static List<ExpandoColumn> getColumns(long companyId, String className, String tableName, Collection<String> columnNames) -
getColumnsCount
public static int getColumnsCount(long tableId) -
getColumnsCount
-
getColumnsCount
-
getDefaultTableColumn
-
getDefaultTableColumn
-
getDefaultTableColumns
-
getDefaultTableColumns
-
getDefaultTableColumnsCount
public static int getDefaultTableColumnsCount(long companyId, long classNameId) -
getDefaultTableColumnsCount
-
getExpandoColumn
Returns the expando column with the primary key.- Parameters:
columnId
- the primary key of the expando column- Returns:
- the expando column
- Throws:
PortalException
- if a expando column with the primary key could not be found
-
getExpandoColumns
Returns a range of all the expando columns.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.expando.model.impl.ExpandoColumnModelImpl
.- Parameters:
start
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)- Returns:
- the range of expando columns
-
getExpandoColumnsCount
public static int getExpandoColumnsCount()Returns the number of expando columns.- Returns:
- the number of expando columns
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
updateColumn
public static ExpandoColumn updateColumn(long columnId, String name, int type) throws PortalException - Throws:
PortalException
-
updateColumn
public static ExpandoColumn updateColumn(long columnId, String name, int type, Object defaultData) throws PortalException - Throws:
PortalException
-
updateExpandoColumn
Updates the expando column in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect ExpandoColumnLocalServiceImpl 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:
expandoColumn
- the expando column- Returns:
- the expando column that was updated
-
updateTypeSettings
public static ExpandoColumn updateTypeSettings(long columnId, String typeSettings) throws PortalException - Throws:
PortalException
-
getService
-
setService
-