Liferay 7.0-ce-m3

com.liferay.portlet.journal.service
Class JournalFeedLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.journal.service.JournalFeedLocalServiceUtil

@ProviderType
public class JournalFeedLocalServiceUtil
extends Object

Provides the local service utility for JournalFeed. This utility wraps com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl and is the primary 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:
JournalFeedLocalService, com.liferay.portlet.journal.service.base.JournalFeedLocalServiceBaseImpl, com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl

Constructor Summary
JournalFeedLocalServiceUtil()
           
 
Method Summary
static JournalFeed addFeed(long userId, long groupId, String feedId, boolean autoFeedId, String name, String description, String ddmStructureKey, String ddmTemplateKey, String ddmRendererTemplateKey, int delta, String orderByCol, String orderByType, String targetLayoutFriendlyUrl, String targetPortletId, String contentField, String feedFormat, double feedVersion, ServiceContext serviceContext)
           
static void addFeedResources(JournalFeed feed, boolean addGroupPermissions, boolean addGuestPermissions)
           
static void addFeedResources(JournalFeed feed, String[] groupPermissions, String[] guestPermissions)
           
static void addFeedResources(long feedId, boolean addGroupPermissions, boolean addGuestPermissions)
           
static void addFeedResources(long feedId, String[] groupPermissions, String[] guestPermissions)
           
static JournalFeed addJournalFeed(JournalFeed journalFeed)
          Adds the journal feed to the database.
static JournalFeed createJournalFeed(long id)
          Creates a new journal feed with the primary key.
static void deleteFeed(JournalFeed feed)
           
static void deleteFeed(long feedId)
           
static void deleteFeed(long groupId, String feedId)
           
static JournalFeed deleteJournalFeed(JournalFeed journalFeed)
          Deletes the journal feed from the database.
static JournalFeed deleteJournalFeed(long id)
          Deletes the journal feed with the primary key from the database.
static PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static DynamicQuery 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 JournalFeed fetchFeed(long groupId, String feedId)
           
static JournalFeed fetchJournalFeed(long id)
           
static JournalFeed fetchJournalFeedByUuidAndGroupId(String uuid, long groupId)
          Returns the journal feed matching the UUID and group.
static ActionableDynamicQuery getActionableDynamicQuery()
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static JournalFeed getFeed(long feedId)
           
static JournalFeed getFeed(long groupId, String feedId)
           
static List<JournalFeed> getFeeds()
           
static List<JournalFeed> getFeeds(long groupId)
           
static List<JournalFeed> getFeeds(long groupId, int start, int end)
           
static int getFeedsCount(long groupId)
           
static JournalFeed getJournalFeed(long id)
          Returns the journal feed with the primary key.
static JournalFeed getJournalFeedByUuidAndGroupId(String uuid, long groupId)
          Returns the journal feed matching the UUID and group.
static List<JournalFeed> getJournalFeeds(int start, int end)
          Returns a range of all the journal feeds.
static List<JournalFeed> getJournalFeedsByUuidAndCompanyId(String uuid, long companyId)
          Returns all the journal feeds matching the UUID and company.
static List<JournalFeed> getJournalFeedsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<JournalFeed> orderByComparator)
          Returns a range of journal feeds matching the UUID and company.
static int getJournalFeedsCount()
          Returns the number of journal feeds.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static JournalFeedLocalService getService()
           
static List<JournalFeed> search(long companyId, long groupId, String keywords, int start, int end, OrderByComparator<JournalFeed> obc)
           
static List<JournalFeed> search(long companyId, long groupId, String feedId, String name, String description, boolean andOperator, int start, int end, OrderByComparator<JournalFeed> obc)
           
static int searchCount(long companyId, long groupId, String keywords)
           
static int searchCount(long companyId, long groupId, String feedId, String name, String description, boolean andOperator)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(JournalFeedLocalService service)
          Deprecated. As of 6.2.0
static JournalFeed updateFeed(long groupId, String feedId, String name, String description, String ddmStructureKey, String ddmTemplateKey, String ddmRendererTemplateKey, int delta, String orderByCol, String orderByType, String targetLayoutFriendlyUrl, String targetPortletId, String contentField, String feedFormat, double feedVersion, ServiceContext serviceContext)
           
static JournalFeed updateJournalFeed(JournalFeed journalFeed)
          Updates the journal feed 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

JournalFeedLocalServiceUtil

public JournalFeedLocalServiceUtil()
Method Detail

addFeed

public static JournalFeed addFeed(long userId,
                                  long groupId,
                                  String feedId,
                                  boolean autoFeedId,
                                  String name,
                                  String description,
                                  String ddmStructureKey,
                                  String ddmTemplateKey,
                                  String ddmRendererTemplateKey,
                                  int delta,
                                  String orderByCol,
                                  String orderByType,
                                  String targetLayoutFriendlyUrl,
                                  String targetPortletId,
                                  String contentField,
                                  String feedFormat,
                                  double feedVersion,
                                  ServiceContext serviceContext)
                           throws PortalException
Throws:
PortalException

addFeedResources

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

addFeedResources

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

addFeedResources

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

addFeedResources

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

addJournalFeed

public static JournalFeed addJournalFeed(JournalFeed journalFeed)
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

createJournalFeed

public static 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

deleteFeed

public static void deleteFeed(JournalFeed feed)
                       throws PortalException
Throws:
PortalException

deleteFeed

public static void deleteFeed(long feedId)
                       throws PortalException
Throws:
PortalException

deleteFeed

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

deleteJournalFeed

public static JournalFeed deleteJournalFeed(long id)
                                     throws PortalException
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

deleteJournalFeed

public static JournalFeed deleteJournalFeed(JournalFeed journalFeed)
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

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(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> List<T> dynamicQuery(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 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 com.liferay.portlet.journal.model.impl.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

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 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 com.liferay.portlet.journal.model.impl.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

dynamicQueryCount

public static long dynamicQueryCount(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(DynamicQuery dynamicQuery,
                                     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

fetchFeed

public static JournalFeed fetchFeed(long groupId,
                                    String feedId)

fetchJournalFeed

public static JournalFeed fetchJournalFeed(long id)

fetchJournalFeedByUuidAndGroupId

public static JournalFeed fetchJournalFeedByUuidAndGroupId(String uuid,
                                                           long groupId)
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

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getFeed

public static JournalFeed getFeed(long feedId)
                           throws PortalException
Throws:
PortalException

getFeed

public static JournalFeed getFeed(long groupId,
                                  String feedId)
                           throws PortalException
Throws:
PortalException

getFeeds

public static List<JournalFeed> getFeeds()

getFeeds

public static List<JournalFeed> getFeeds(long groupId)

getFeeds

public static List<JournalFeed> getFeeds(long groupId,
                                         int start,
                                         int end)

getFeedsCount

public static int getFeedsCount(long groupId)

getJournalFeed

public static JournalFeed getJournalFeed(long id)
                                  throws PortalException
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

getJournalFeedByUuidAndGroupId

public static JournalFeed getJournalFeedByUuidAndGroupId(String uuid,
                                                         long groupId)
                                                  throws PortalException
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

getJournalFeeds

public static List<JournalFeed> getJournalFeeds(int start,
                                                int end)
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 com.liferay.portlet.journal.model.impl.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

getJournalFeedsByUuidAndCompanyId

public static List<JournalFeed> getJournalFeedsByUuidAndCompanyId(String uuid,
                                                                  long companyId)
Returns all the journal feeds matching the UUID and company.

Parameters:
uuid - the UUID of the journal feeds
companyId - the primary key of the company
Returns:
the matching journal feeds, or an empty list if no matches were found

getJournalFeedsByUuidAndCompanyId

public static List<JournalFeed> getJournalFeedsByUuidAndCompanyId(String uuid,
                                                                  long companyId,
                                                                  int start,
                                                                  int end,
                                                                  OrderByComparator<JournalFeed> orderByComparator)
Returns a range of journal feeds matching the UUID and company.

Parameters:
uuid - the UUID of the journal feeds
companyId - the primary key of the company
start - the lower bound of the range of journal feeds
end - the upper bound of the range of journal feeds (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the range of matching journal feeds, or an empty list if no matches were found

getJournalFeedsCount

public static int getJournalFeedsCount()
Returns the number of journal feeds.

Returns:
the number of journal feeds

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

search

public static List<JournalFeed> search(long companyId,
                                       long groupId,
                                       String feedId,
                                       String name,
                                       String description,
                                       boolean andOperator,
                                       int start,
                                       int end,
                                       OrderByComparator<JournalFeed> obc)

search

public static List<JournalFeed> search(long companyId,
                                       long groupId,
                                       String keywords,
                                       int start,
                                       int end,
                                       OrderByComparator<JournalFeed> obc)

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              String feedId,
                              String name,
                              String description,
                              boolean andOperator)

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              String keywords)

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

updateFeed

public static JournalFeed updateFeed(long groupId,
                                     String feedId,
                                     String name,
                                     String description,
                                     String ddmStructureKey,
                                     String ddmTemplateKey,
                                     String ddmRendererTemplateKey,
                                     int delta,
                                     String orderByCol,
                                     String orderByType,
                                     String targetLayoutFriendlyUrl,
                                     String targetPortletId,
                                     String contentField,
                                     String feedFormat,
                                     double feedVersion,
                                     ServiceContext serviceContext)
                              throws PortalException
Throws:
PortalException

updateJournalFeed

public static JournalFeed updateJournalFeed(JournalFeed journalFeed)
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

getService

public static JournalFeedLocalService getService()

setService

@Deprecated
public void setService(JournalFeedLocalService service)
Deprecated. As of 6.2.0


Liferay 7.0-ce-m3