com.liferay.json.storage.service

Interface JSONStorageEntryLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<JSONStorageEntry>, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

JSONStorageEntryLocalServiceWrapper

@CTAware
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface JSONStorageEntryLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<JSONStorageEntry>, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for JSONStorageEntry. 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:

JSONStorageEntryLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
void	addJSONStorageEntries(long companyId, long classNameId, long classPK, java.lang.String json)
JSONStorageEntry	addJSONStorageEntry(JSONStorageEntry jsonStorageEntry) Adds the json storage entry to the database.
JSONStorageEntry	createJSONStorageEntry(long jsonStorageEntryId) Creates a new json storage entry with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
void	deleteJSONStorageEntries(long classNameId, long classPK)
JSONStorageEntry	deleteJSONStorageEntry(JSONStorageEntry jsonStorageEntry) Deletes the json storage entry from the database.
JSONStorageEntry	deleteJSONStorageEntry(long jsonStorageEntryId) Deletes the json storage entry with the primary key from the database.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<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.
<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.
<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.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
JSONStorageEntry	fetchJSONStorageEntry(long jsonStorageEntryId)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
java.util.List<java.lang.Long>	getClassPKs(long companyId, long classNameId, int start, int end)
java.util.List<java.lang.Long>	getClassPKs(long companyId, long classNameId, java.lang.Object[] pathParts, java.lang.Object value, int start, int end)
int	getClassPKsCount(long companyId, long classNameId)
int	getClassPKsCount(long companyId, long classNameId, java.lang.Object[] pathParts, java.lang.Object value)
com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<JSONStorageEntry>	getCTPersistence()
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getJSON(long classNameId, long classPK)
com.liferay.portal.kernel.json.JSONArray	getJSONArray(long classNameId, long classPK)
com.liferay.portal.kernel.json.JSONObject	getJSONObject(long classNameId, long classPK)
com.liferay.portal.kernel.json.JSONSerializable	getJSONSerializable(long classNameId, long classPK)
java.util.List<JSONStorageEntry>	getJSONStorageEntries(int start, int end) Returns a range of all the json storage entries.
int	getJSONStorageEntriesCount() Returns the number of json storage entries.
JSONStorageEntry	getJSONStorageEntry(long jsonStorageEntryId) Returns the json storage entry with the primary key.
java.lang.Class<JSONStorageEntry>	getModelClass()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
void	updateJSONStorageEntries(long companyId, long classNameId, long classPK, java.lang.String json)
JSONStorageEntry	updateJSONStorageEntry(JSONStorageEntry jsonStorageEntry) Updates the json storage entry in the database or adds it if it does not yet exist.
<R,E extends java.lang.Throwable> R	updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<JSONStorageEntry>,R,E> updateUnsafeFunction)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addJSONStorageEntries

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

addJSONStorageEntry

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

@Transactional(enabled=false)
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

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

Specified by:

createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteJSONStorageEntries

void deleteJSONStorageEntries(long classNameId,
                              long classPK)

deleteJSONStorageEntry

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

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

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JSONStorageEntry fetchJSONStorageEntry(long jsonStorageEntryId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getClassPKs

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Long> getClassPKs(long companyId,
                                                                                                              long classNameId,
                                                                                                              int start,
                                                                                                              int end)

getClassPKs

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Long> getClassPKs(long companyId,
                                                                                                              long classNameId,
                                                                                                              java.lang.Object[] pathParts,
                                                                                                              java.lang.Object value,
                                                                                                              int start,
                                                                                                              int end)

getClassPKsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getClassPKsCount(long companyId,
                                                                                        long classNameId)

getClassPKsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getClassPKsCount(long companyId,
                                                                                        long classNameId,
                                                                                        java.lang.Object[] pathParts,
                                                                                        java.lang.Object value)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getJSON

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String getJSON(long classNameId,
                                                                                            long classPK)

getJSONArray

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.json.JSONArray getJSONArray(long classNameId,
                                                                                                                         long classPK)

getJSONObject

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.json.JSONObject getJSONObject(long classNameId,
                                                                                                                           long classPK)

getJSONSerializable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.json.JSONSerializable getJSONSerializable(long classNameId,
                                                                                                                                       long classPK)

getJSONStorageEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getJSONStorageEntriesCount()

Returns the number of json storage entries.

Returns:

the number of json storage entries

getJSONStorageEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

updateJSONStorageEntries

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

updateJSONStorageEntry

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

getCTPersistence

@Transactional(enabled=false)
com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<JSONStorageEntry> getCTPersistence()

Specified by:

getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<JSONStorageEntry>

getModelClass

@Transactional(enabled=false)
java.lang.Class<JSONStorageEntry> getModelClass()

Specified by:

getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<JSONStorageEntry>

updateWithUnsafeFunction

@Transactional(rollbackFor=java.lang.Throwable.class)
<R,E extends java.lang.Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<JSONStorageEntry>,R,E> updateUnsafeFunction)
                                                                                                            throws E extends java.lang.Throwable

Specified by:

updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<JSONStorageEntry>

Throws:

E extends java.lang.Throwable