com.liferay.microblogs.service.MicroblogsEntryLocalService Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.microblogs.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.microblogs.model.MicroblogsEntry;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import java.io.Serializable;
import java.util.List;
/**
* Provides the local service interface for MicroblogsEntry. 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 MicroblogsEntryLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface MicroblogsEntryLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link MicroblogsEntryLocalServiceUtil} to access the microblogs entry local service. Add custom service methods to com.liferay.microblogs.service.impl.MicroblogsEntryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
public MicroblogsEntry addMicroblogsEntry(
long userId, long creatorClassNameId, long creatorClassPK,
String content, int type, long parentMicroblogsEntryId,
int socialRelationType, ServiceContext serviceContext)
throws PortalException;
public MicroblogsEntry addMicroblogsEntry(
long userId, String content, int type, long parentMicroblogsEntryId,
int socialRelationType, ServiceContext serviceContext)
throws PortalException;
/**
* Adds the microblogs entry to the database. Also notifies the appropriate model listeners.
*
* @param microblogsEntry the microblogs entry
* @return the microblogs entry that was added
*/
@Indexable(type = IndexableType.REINDEX)
public MicroblogsEntry addMicroblogsEntry(MicroblogsEntry microblogsEntry);
/**
* Creates a new microblogs entry with the primary key. Does not add the microblogs entry to the database.
*
* @param microblogsEntryId the primary key for the new microblogs entry
* @return the new microblogs entry
*/
@Transactional(enabled = false)
public MicroblogsEntry createMicroblogsEntry(long microblogsEntryId);
public void deleteMicroblogsEntries(
long creatorClassNameId, long creatorClassPK)
throws PortalException;
/**
* Deletes the microblogs entry with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param microblogsEntryId the primary key of the microblogs entry
* @return the microblogs entry that was removed
* @throws PortalException if a microblogs entry with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public MicroblogsEntry deleteMicroblogsEntry(long microblogsEntryId)
throws PortalException;
/**
* Deletes the microblogs entry from the database. Also notifies the appropriate model listeners.
*
* @param microblogsEntry the microblogs entry
* @return the microblogs entry that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
public MicroblogsEntry deleteMicroblogsEntry(
MicroblogsEntry microblogsEntry)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
public void deleteUserMicroblogsEntries(long userId) throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(DynamicQuery 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 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.microblogs.model.impl.MicroblogsEntryModelImpl. 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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end);
/**
* 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.microblogs.model.impl.MicroblogsEntryModelImpl. 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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery dynamicQuery);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public MicroblogsEntry fetchMicroblogsEntry(long microblogsEntryId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCompanyMicroblogsEntries(
long companyId, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCompanyMicroblogsEntriesCount(long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns a range of all the microblogs 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.microblogs.model.impl.MicroblogsEntryModelImpl. 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.
*
*
* @param start the lower bound of the range of microblogs entries
* @param end the upper bound of the range of microblogs entries (not inclusive)
* @return the range of microblogs entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMicroblogsEntries(int start, int end);
/**
* @deprecated As of Judson (7.1.x)
*/
@Deprecated
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMicroblogsEntries(
long creatorClassNameId, int type, int start, int end,
OrderByComparator obc);
/**
* @deprecated As of Judson (7.1.x)
*/
@Deprecated
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMicroblogsEntries(
long creatorClassNameId, long creatorClassPK, int start, int end);
/**
* @deprecated As of Judson (7.1.x)
*/
@Deprecated
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMicroblogsEntries(
long creatorClassNameId, long creatorClassPK, int type, int start,
int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMicroblogsEntries(
long companyId, long creatorClassNameId, int type, int start, int end,
OrderByComparator obc);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMicroblogsEntries(
long companyId, long creatorClassNameId, long creatorClassPK, int start,
int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMicroblogsEntries(
long companyId, long creatorClassNameId, long creatorClassPK, int type,
int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMicroblogsEntries(
long companyId, long creatorClassNameId, long creatorClassPK,
String assetTagName, boolean andOperator, int start, int end);
/**
* @deprecated As of Judson (7.1.x)
*/
@Deprecated
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMicroblogsEntries(
long creatorClassNameId, long creatorClassPK, String assetTagName,
boolean andOperator, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMicroblogsEntries(
long companyId, long creatorClassNameId, String assetTagName, int start,
int end);
/**
* @deprecated As of Judson (7.1.x)
*/
@Deprecated
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMicroblogsEntries(
long creatorClassNameId, String assetTagName, int start, int end);
/**
* Returns the number of microblogs entries.
*
* @return the number of microblogs entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getMicroblogsEntriesCount();
/**
* @deprecated As of Judson (7.1.x)
*/
@Deprecated
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getMicroblogsEntriesCount(
long creatorClassNameId, long creatorClassPK);
/**
* @deprecated As of Judson (7.1.x)
*/
@Deprecated
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getMicroblogsEntriesCount(
long creatorClassNameId, long creatorClassPK, int type);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getMicroblogsEntriesCount(
long companyId, long creatorClassNameId, long creatorClassPK);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getMicroblogsEntriesCount(
long companyId, long creatorClassNameId, long creatorClassPK, int type);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getMicroblogsEntriesCount(
long companyId, long creatorClassNameId, long creatorClassPK,
String assetTagName, boolean andOperator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getMicroblogsEntriesCount(
long companyId, long creatorClassNameId, String assetTagName);
/**
* @deprecated As of Judson (7.1.x)
*/
@Deprecated
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getMicroblogsEntriesCount(
long creatorClassNameId, long creatorClassPK, String assetTagName,
boolean andOperator);
/**
* @deprecated As of Judson (7.1.x)
*/
@Deprecated
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getMicroblogsEntriesCount(
long creatorClassNameId, String assetTagName);
/**
* Returns the microblogs entry with the primary key.
*
* @param microblogsEntryId the primary key of the microblogs entry
* @return the microblogs entry
* @throws PortalException if a microblogs entry with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public MicroblogsEntry getMicroblogsEntry(long microblogsEntryId)
throws PortalException;
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getParentMicroblogsEntryMicroblogsEntries(
int type, long parentMicroblogsEntryId, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getParentMicroblogsEntryMicroblogsEntries(
int type, long parentMicroblogsEntryId, int start, int end,
OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getParentMicroblogsEntryMicroblogsEntriesCount(
int type, long parentMicroblogsEntryId);
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getUserMicroblogsEntries(
long userId, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getUserMicroblogsEntries(
long userId, int type, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getUserMicroblogsEntriesCount(long userId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getUserMicroblogsEntriesCount(long userId, int type);
public void updateAsset(
MicroblogsEntry microblogsEntry, long[] assetCategoryIds,
String[] assetTagNames)
throws PortalException;
public MicroblogsEntry updateMicroblogsEntry(
long microblogsEntryId, String content, int socialRelationType,
ServiceContext serviceContext)
throws PortalException;
/**
* Updates the microblogs entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param microblogsEntry the microblogs entry
* @return the microblogs entry that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public MicroblogsEntry updateMicroblogsEntry(
MicroblogsEntry microblogsEntry);
}