com.liferay.json.storage.service

Class JSONStorageEntryLocalServiceUtil

java.lang.Object

com.liferay.json.storage.service.JSONStorageEntryLocalServiceUtil

public class JSONStorageEntryLocalServiceUtil
extends java.lang.Object

Provides the local service utility for JSONStorageEntry. This utility wraps com.liferay.json.storage.service.impl.JSONStorageEntryLocalServiceImpl 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.

See Also:

JSONStorageEntryLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
JSONStorageEntryLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static void	addJSONStorageEntries(long companyId, long classNameId, long classPK, java.lang.String json)
static JSONStorageEntry	addJSONStorageEntry(JSONStorageEntry jsonStorageEntry) Adds the json storage entry to the database.
static JSONStorageEntry	createJSONStorageEntry(long jsonStorageEntryId) Creates a new json storage entry with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static void	deleteJSONStorageEntries(long classNameId, long classPK)
static JSONStorageEntry	deleteJSONStorageEntry(JSONStorageEntry jsonStorageEntry) Deletes the json storage entry from the database.
static JSONStorageEntry	deleteJSONStorageEntry(long jsonStorageEntryId) Deletes the json storage entry with the primary key from the database.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
static JSONStorageEntry	fetchJSONStorageEntry(long jsonStorageEntryId)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static java.util.List<java.lang.Long>	getClassPKs(long companyId, long classNameId, int start, int end)
static java.util.List<java.lang.Long>	getClassPKs(long companyId, long classNameId, java.lang.Object[] pathParts, java.lang.Object value, int start, int end)
static int	getClassPKsCount(long companyId, long classNameId)
static int	getClassPKsCount(long companyId, long classNameId, java.lang.Object[] pathParts, java.lang.Object value)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getJSON(long classNameId, long classPK)
static com.liferay.portal.kernel.json.JSONArray	getJSONArray(long classNameId, long classPK)
static com.liferay.portal.kernel.json.JSONObject	getJSONObject(long classNameId, long classPK)
static com.liferay.portal.kernel.json.JSONSerializable	getJSONSerializable(long classNameId, long classPK)
static java.util.List<JSONStorageEntry>	getJSONStorageEntries(int start, int end) Returns a range of all the json storage entries.
static int	getJSONStorageEntriesCount() Returns the number of json storage entries.
static JSONStorageEntry	getJSONStorageEntry(long jsonStorageEntryId) Returns the json storage entry with the primary key.
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static JSONStorageEntryLocalService	getService()
static void	updateJSONStorageEntries(long companyId, long classNameId, long classPK, java.lang.String json)
static JSONStorageEntry	updateJSONStorageEntry(JSONStorageEntry jsonStorageEntry) Updates the json storage entry in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSONStorageEntryLocalServiceUtil

public JSONStorageEntryLocalServiceUtil()

Method Detail

addJSONStorageEntries

public static void addJSONStorageEntries(long companyId,
                                         long classNameId,
                                         long classPK,
                                         java.lang.String json)

addJSONStorageEntry

public static JSONStorageEntry addJSONStorageEntry(JSONStorageEntry jsonStorageEntry)

Adds the json storage entry to the database. Also notifies the appropriate model listeners.

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

jsonStorageEntry - the json storage entry

Returns:

the json storage entry that was added

createJSONStorageEntry

public static JSONStorageEntry createJSONStorageEntry(long jsonStorageEntryId)

Creates a new json storage entry with the primary key. Does not add the json storage entry to the database.

Parameters:

jsonStorageEntryId - the primary key for the new json storage entry

Returns:

the new json storage entry

createPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteJSONStorageEntries

public static void deleteJSONStorageEntries(long classNameId,
                                            long classPK)

deleteJSONStorageEntry

public static JSONStorageEntry deleteJSONStorageEntry(JSONStorageEntry jsonStorageEntry)

Deletes the json storage entry from the database. Also notifies the appropriate model listeners.

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

jsonStorageEntry - the json storage entry

Returns:

the json storage entry that was removed

deleteJSONStorageEntry

public static JSONStorageEntry deleteJSONStorageEntry(long jsonStorageEntryId)
                                               throws com.liferay.portal.kernel.exception.PortalException

Deletes the json storage entry with the primary key from the database. Also notifies the appropriate model listeners.

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

jsonStorageEntryId - the primary key of the json storage entry

Returns:

the json storage entry that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a json storage entry with the primary key could not be found

deletePersistedModel

public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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.json.storage.model.impl.JSONStorageEntryModelImpl.

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> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.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.json.storage.model.impl.JSONStorageEntryModelImpl.

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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                     com.liferay.portal.kernel.dao.orm.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

fetchJSONStorageEntry

public static JSONStorageEntry fetchJSONStorageEntry(long jsonStorageEntryId)

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getClassPKs

public static java.util.List<java.lang.Long> getClassPKs(long companyId,
                                                         long classNameId,
                                                         int start,
                                                         int end)

getClassPKs

public static java.util.List<java.lang.Long> getClassPKs(long companyId,
                                                         long classNameId,
                                                         java.lang.Object[] pathParts,
                                                         java.lang.Object value,
                                                         int start,
                                                         int end)

getClassPKsCount

public static int getClassPKsCount(long companyId,
                                   long classNameId)

getClassPKsCount

public static int getClassPKsCount(long companyId,
                                   long classNameId,
                                   java.lang.Object[] pathParts,
                                   java.lang.Object value)

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getJSON

public static java.lang.String getJSON(long classNameId,
                                       long classPK)

getJSONArray

public static com.liferay.portal.kernel.json.JSONArray getJSONArray(long classNameId,
                                                                    long classPK)

getJSONObject

public static com.liferay.portal.kernel.json.JSONObject getJSONObject(long classNameId,
                                                                      long classPK)

getJSONSerializable

public static com.liferay.portal.kernel.json.JSONSerializable getJSONSerializable(long classNameId,
                                                                                  long classPK)

getJSONStorageEntries

public static java.util.List<JSONStorageEntry> getJSONStorageEntries(int start,
                                                                     int end)

Returns a range of all the json storage entries.

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.json.storage.model.impl.JSONStorageEntryModelImpl.

Parameters:

start - the lower bound of the range of json storage entries

end - the upper bound of the range of json storage entries (not inclusive)

Returns:

the range of json storage entries

getJSONStorageEntriesCount

public static int getJSONStorageEntriesCount()

Returns the number of json storage entries.

Returns:

the number of json storage entries

getJSONStorageEntry

public static JSONStorageEntry getJSONStorageEntry(long jsonStorageEntryId)
                                            throws com.liferay.portal.kernel.exception.PortalException

Returns the json storage entry with the primary key.

Parameters:

jsonStorageEntryId - the primary key of the json storage entry

Returns:

the json storage entry

Throws:

com.liferay.portal.kernel.exception.PortalException - if a json storage entry with the primary key could not be found

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateJSONStorageEntries

public static void updateJSONStorageEntries(long companyId,
                                            long classNameId,
                                            long classPK,
                                            java.lang.String json)

updateJSONStorageEntry

public static JSONStorageEntry updateJSONStorageEntry(JSONStorageEntry jsonStorageEntry)

Updates the json storage entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

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

jsonStorageEntry - the json storage entry

Returns:

the json storage entry that was updated

getService

public static JSONStorageEntryLocalService getService()