Liferay 6.2-ce-ga5

com.liferay.portlet.journal.service
Interface JournalFeedLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
JournalFeedLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface JournalFeedLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for JournalFeed. 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:
JournalFeedLocalServiceUtil, com.liferay.portlet.journal.service.base.JournalFeedLocalServiceBaseImpl, com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl

Method Summary
 JournalFeed addFeed(long userId, long groupId, String feedId, boolean autoFeedId, String name, String description, String type, String structureId, String templateId, String rendererTemplateId, int delta, String orderByCol, String orderByType, String targetLayoutFriendlyUrl, String targetPortletId, String contentField, String feedFormat, double feedVersion, ServiceContext serviceContext)
           
 void addFeedResources(JournalFeed feed, boolean addGroupPermissions, boolean addGuestPermissions)
           
 void addFeedResources(JournalFeed feed, String[] groupPermissions, String[] guestPermissions)
           
 void addFeedResources(long feedId, boolean addGroupPermissions, boolean addGuestPermissions)
           
 void addFeedResources(long feedId, String[] groupPermissions, String[] guestPermissions)
           
 JournalFeed addJournalFeed(JournalFeed journalFeed)
          Adds the journal feed to the database.
 JournalFeed createJournalFeed(long id)
          Creates a new journal feed with the primary key.
 void deleteFeed(JournalFeed feed)
           
 void deleteFeed(long feedId)
           
 void deleteFeed(long groupId, String feedId)
           
 JournalFeed deleteJournalFeed(JournalFeed journalFeed)
          Deletes the journal feed from the database.
 JournalFeed deleteJournalFeed(long id)
          Deletes the journal feed with the primary key from the database.
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 JournalFeed fetchFeed(long groupId, String feedId)
           
 JournalFeed fetchJournalFeed(long id)
           
 JournalFeed fetchJournalFeedByUuidAndCompanyId(String uuid, long companyId)
          Returns the journal feed with the matching UUID and company.
 JournalFeed fetchJournalFeedByUuidAndGroupId(String uuid, long groupId)
          Returns the journal feed matching the UUID and group.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 JournalFeed getFeed(long feedId)
           
 JournalFeed getFeed(long groupId, String feedId)
           
 List<JournalFeed> getFeeds()
           
 List<JournalFeed> getFeeds(long groupId)
           
 List<JournalFeed> getFeeds(long groupId, int start, int end)
           
 int getFeedsCount(long groupId)
           
 JournalFeed getJournalFeed(long id)
          Returns the journal feed with the primary key.
 JournalFeed getJournalFeedByUuidAndCompanyId(String uuid, long companyId)
          Returns the journal feed with the matching UUID and company.
 JournalFeed getJournalFeedByUuidAndGroupId(String uuid, long groupId)
          Returns the journal feed matching the UUID and group.
 List<JournalFeed> getJournalFeeds(int start, int end)
          Returns a range of all the journal feeds.
 int getJournalFeedsCount()
          Returns the number of journal feeds.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<JournalFeed> search(long companyId, long groupId, String keywords, int start, int end, OrderByComparator obc)
           
 List<JournalFeed> search(long companyId, long groupId, String feedId, String name, String description, boolean andOperator, int start, int end, OrderByComparator obc)
           
 int searchCount(long companyId, long groupId, String keywords)
           
 int searchCount(long companyId, long groupId, String feedId, String name, String description, boolean andOperator)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 JournalFeed updateFeed(long groupId, String feedId, String name, String description, String type, String structureId, String templateId, String rendererTemplateId, int delta, String orderByCol, String orderByType, String targetLayoutFriendlyUrl, String targetPortletId, String contentField, String feedFormat, double feedVersion, ServiceContext serviceContext)
           
 JournalFeed updateJournalFeed(JournalFeed journalFeed)
          Updates the journal feed in the database or adds it if it does not yet exist.
 

Method Detail

addJournalFeed

@Indexable(type=REINDEX)
JournalFeed addJournalFeed(JournalFeed journalFeed)
                           throws SystemException
Adds the journal feed to the database. Also notifies the appropriate model listeners.

Parameters:
journalFeed - the journal feed
Returns:
the journal feed that was added
Throws:
SystemException - if a system exception occurred

createJournalFeed

JournalFeed createJournalFeed(long id)
Creates a new journal feed with the primary key. Does not add the journal feed to the database.

Parameters:
id - the primary key for the new journal feed
Returns:
the new journal feed

deleteJournalFeed

@Indexable(type=DELETE)
JournalFeed deleteJournalFeed(long id)
                              throws PortalException,
                                     SystemException
Deletes the journal feed with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
id - the primary key of the journal feed
Returns:
the journal feed that was removed
Throws:
PortalException - if a journal feed with the primary key could not be found
SystemException - if a system exception occurred

deleteJournalFeed

@Indexable(type=DELETE)
JournalFeed deleteJournalFeed(JournalFeed journalFeed)
                              throws SystemException
Deletes the journal feed from the database. Also notifies the appropriate model listeners.

Parameters:
journalFeed - the journal feed
Returns:
the journal feed that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from JournalFeedModelImpl. 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.

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
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from JournalFeedModelImpl. 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.

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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchJournalFeed

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFeed fetchJournalFeed(long id)
                             throws SystemException
Throws:
SystemException

fetchJournalFeedByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFeed fetchJournalFeedByUuidAndCompanyId(String uuid,
                                                                                        long companyId)
                                               throws SystemException
Returns the journal feed with the matching UUID and company.

Parameters:
uuid - the journal feed's UUID
companyId - the primary key of the company
Returns:
the matching journal feed, or null if a matching journal feed could not be found
Throws:
SystemException - if a system exception occurred

fetchJournalFeedByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFeed fetchJournalFeedByUuidAndGroupId(String uuid,
                                                                                      long groupId)
                                             throws SystemException
Returns the journal feed matching the UUID and group.

Parameters:
uuid - the journal feed's UUID
groupId - the primary key of the group
Returns:
the matching journal feed, or null if a matching journal feed could not be found
Throws:
SystemException - if a system exception occurred

getJournalFeed

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFeed getJournalFeed(long id)
                           throws PortalException,
                                  SystemException
Returns the journal feed with the primary key.

Parameters:
id - the primary key of the journal feed
Returns:
the journal feed
Throws:
PortalException - if a journal feed with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getJournalFeedByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFeed getJournalFeedByUuidAndCompanyId(String uuid,
                                                                                      long companyId)
                                             throws PortalException,
                                                    SystemException
Returns the journal feed with the matching UUID and company.

Parameters:
uuid - the journal feed's UUID
companyId - the primary key of the company
Returns:
the matching journal feed
Throws:
PortalException - if a matching journal feed could not be found
SystemException - if a system exception occurred

getJournalFeedByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFeed getJournalFeedByUuidAndGroupId(String uuid,
                                                                                    long groupId)
                                           throws PortalException,
                                                  SystemException
Returns the journal feed matching the UUID and group.

Parameters:
uuid - the journal feed's UUID
groupId - the primary key of the group
Returns:
the matching journal feed
Throws:
PortalException - if a matching journal feed could not be found
SystemException - if a system exception occurred

getJournalFeeds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFeed> getJournalFeeds(int start,
                                                                           int end)
                                  throws SystemException
Returns a range of all the journal feeds.

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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from JournalFeedModelImpl. 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.

Parameters:
start - the lower bound of the range of journal feeds
end - the upper bound of the range of journal feeds (not inclusive)
Returns:
the range of journal feeds
Throws:
SystemException - if a system exception occurred

getJournalFeedsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getJournalFeedsCount()
                         throws SystemException
Returns the number of journal feeds.

Returns:
the number of journal feeds
Throws:
SystemException - if a system exception occurred

updateJournalFeed

@Indexable(type=REINDEX)
JournalFeed updateJournalFeed(JournalFeed journalFeed)
                              throws SystemException
Updates the journal feed in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
journalFeed - the journal feed
Returns:
the journal feed that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addFeed

JournalFeed addFeed(long userId,
                    long groupId,
                    String feedId,
                    boolean autoFeedId,
                    String name,
                    String description,
                    String type,
                    String structureId,
                    String templateId,
                    String rendererTemplateId,
                    int delta,
                    String orderByCol,
                    String orderByType,
                    String targetLayoutFriendlyUrl,
                    String targetPortletId,
                    String contentField,
                    String feedFormat,
                    double feedVersion,
                    ServiceContext serviceContext)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

addFeedResources

void addFeedResources(JournalFeed feed,
                      boolean addGroupPermissions,
                      boolean addGuestPermissions)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

addFeedResources

void addFeedResources(JournalFeed feed,
                      String[] groupPermissions,
                      String[] guestPermissions)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

addFeedResources

void addFeedResources(long feedId,
                      boolean addGroupPermissions,
                      boolean addGuestPermissions)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

addFeedResources

void addFeedResources(long feedId,
                      String[] groupPermissions,
                      String[] guestPermissions)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

deleteFeed

@SystemEvent(type=1)
void deleteFeed(JournalFeed feed)
                throws PortalException,
                       SystemException
Throws:
PortalException
SystemException

deleteFeed

void deleteFeed(long feedId)
                throws PortalException,
                       SystemException
Throws:
PortalException
SystemException

deleteFeed

void deleteFeed(long groupId,
                String feedId)
                throws PortalException,
                       SystemException
Throws:
PortalException
SystemException

fetchFeed

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFeed fetchFeed(long groupId,
                                                               String feedId)
                      throws SystemException
Throws:
SystemException

getFeed

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFeed getFeed(long feedId)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

getFeed

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFeed getFeed(long groupId,
                                                             String feedId)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

getFeeds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFeed> getFeeds()
                           throws SystemException
Throws:
SystemException

getFeeds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFeed> getFeeds(long groupId)
                           throws SystemException
Throws:
SystemException

getFeeds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFeed> getFeeds(long groupId,
                                                                    int start,
                                                                    int end)
                           throws SystemException
Throws:
SystemException

getFeedsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFeedsCount(long groupId)
                  throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFeed> search(long companyId,
                                                                  long groupId,
                                                                  String keywords,
                                                                  int start,
                                                                  int end,
                                                                  OrderByComparator obc)
                         throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFeed> search(long companyId,
                                                                  long groupId,
                                                                  String feedId,
                                                                  String name,
                                                                  String description,
                                                                  boolean andOperator,
                                                                  int start,
                                                                  int end,
                                                                  OrderByComparator obc)
                         throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         long groupId,
                                                         String keywords)
                throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         long groupId,
                                                         String feedId,
                                                         String name,
                                                         String description,
                                                         boolean andOperator)
                throws SystemException
Throws:
SystemException

updateFeed

JournalFeed updateFeed(long groupId,
                       String feedId,
                       String name,
                       String description,
                       String type,
                       String structureId,
                       String templateId,
                       String rendererTemplateId,
                       int delta,
                       String orderByCol,
                       String orderByType,
                       String targetLayoutFriendlyUrl,
                       String targetPortletId,
                       String contentField,
                       String feedFormat,
                       double feedVersion,
                       ServiceContext serviceContext)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5