Liferay 7.0-ce-b4

com.liferay.portlet.ratings.service
Class RatingsEntryLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.ratings.service.RatingsEntryLocalServiceUtil

@ProviderType
public class RatingsEntryLocalServiceUtil
extends Object

Provides the local service utility for RatingsEntry. This utility wraps RatingsEntryLocalServiceImpl 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:
RatingsEntryLocalService, RatingsEntryLocalServiceBaseImpl, RatingsEntryLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
RatingsEntryLocalServiceUtil()
           
 
Method Summary
static RatingsEntry addRatingsEntry(RatingsEntry ratingsEntry)
          Adds the ratings entry to the database.
static RatingsEntry createRatingsEntry(long entryId)
          Creates a new ratings entry with the primary key.
static void deleteEntry(long userId, String className, long classPK)
           
static void deleteEntry(RatingsEntry entry, long userId, String className, long classPK)
           
static PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static RatingsEntry deleteRatingsEntry(long entryId)
          Deletes the ratings entry with the primary key from the database.
static RatingsEntry deleteRatingsEntry(RatingsEntry ratingsEntry)
          Deletes the ratings entry from the database.
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 RatingsEntry fetchEntry(long userId, String className, long classPK)
           
static RatingsEntry fetchRatingsEntry(long entryId)
           
static RatingsEntry fetchRatingsEntryByUuidAndCompanyId(String uuid, long companyId)
          Returns the ratings entry with the matching UUID and company.
static ActionableDynamicQuery getActionableDynamicQuery()
           
static List<RatingsEntry> getEntries(long userId, String className, List<Long> classPKs)
           
static List<RatingsEntry> getEntries(String className, long classPK)
           
static List<RatingsEntry> getEntries(String className, long classPK, double score)
           
static int getEntriesCount(String className, long classPK, double score)
           
static RatingsEntry getEntry(long userId, String className, long classPK)
           
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
static String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static List<RatingsEntry> getRatingsEntries(int start, int end)
          Returns a range of all the ratings entries.
static int getRatingsEntriesCount()
          Returns the number of ratings entries.
static RatingsEntry getRatingsEntry(long entryId)
          Returns the ratings entry with the primary key.
static RatingsEntry getRatingsEntryByUuidAndCompanyId(String uuid, long companyId)
          Returns the ratings entry with the matching UUID and company.
static RatingsEntryLocalService getService()
           
static RatingsEntry updateEntry(long userId, String className, long classPK, double score, ServiceContext serviceContext)
           
static RatingsEntry updateRatingsEntry(RatingsEntry ratingsEntry)
          Updates the ratings 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

RatingsEntryLocalServiceUtil

public RatingsEntryLocalServiceUtil()
Method Detail

addRatingsEntry

public static RatingsEntry addRatingsEntry(RatingsEntry ratingsEntry)
Adds the ratings entry to the database. Also notifies the appropriate model listeners.

Parameters:
ratingsEntry - the ratings entry
Returns:
the ratings entry that was added

createRatingsEntry

public static RatingsEntry createRatingsEntry(long entryId)
Creates a new ratings entry with the primary key. Does not add the ratings entry to the database.

Parameters:
entryId - the primary key for the new ratings entry
Returns:
the new ratings entry

deleteEntry

public static void deleteEntry(RatingsEntry entry,
                               long userId,
                               String className,
                               long classPK)
                        throws PortalException
Throws:
PortalException

deleteEntry

public static void deleteEntry(long userId,
                               String className,
                               long classPK)
                        throws PortalException
Throws:
PortalException

deletePersistedModel

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

deleteRatingsEntry

public static RatingsEntry deleteRatingsEntry(long entryId)
                                       throws PortalException
Deletes the ratings entry with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
entryId - the primary key of the ratings entry
Returns:
the ratings entry that was removed
Throws:
PortalException - if a ratings entry with the primary key could not be found

deleteRatingsEntry

public static RatingsEntry deleteRatingsEntry(RatingsEntry ratingsEntry)
Deletes the ratings entry from the database. Also notifies the appropriate model listeners.

Parameters:
ratingsEntry - the ratings entry
Returns:
the ratings entry that was removed

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 RatingsEntryModelImpl. 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 RatingsEntryModelImpl. 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

fetchEntry

public static RatingsEntry fetchEntry(long userId,
                                      String className,
                                      long classPK)

fetchRatingsEntry

public static RatingsEntry fetchRatingsEntry(long entryId)

fetchRatingsEntryByUuidAndCompanyId

public static RatingsEntry fetchRatingsEntryByUuidAndCompanyId(String uuid,
                                                               long companyId)
Returns the ratings entry with the matching UUID and company.

Parameters:
uuid - the ratings entry's UUID
companyId - the primary key of the company
Returns:
the matching ratings entry, or null if a matching ratings entry could not be found

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getEntries

public static List<RatingsEntry> getEntries(String className,
                                            long classPK)

getEntries

public static List<RatingsEntry> getEntries(String className,
                                            long classPK,
                                            double score)

getEntries

public static List<RatingsEntry> getEntries(long userId,
                                            String className,
                                            List<Long> classPKs)

getEntriesCount

public static int getEntriesCount(String className,
                                  long classPK,
                                  double score)

getEntry

public static RatingsEntry getEntry(long userId,
                                    String className,
                                    long classPK)
                             throws PortalException
Throws:
PortalException

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

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

getRatingsEntries

public static List<RatingsEntry> getRatingsEntries(int start,
                                                   int end)
Returns a range of all the ratings 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 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 RatingsEntryModelImpl. 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 ratings entries
end - the upper bound of the range of ratings entries (not inclusive)
Returns:
the range of ratings entries

getRatingsEntriesCount

public static int getRatingsEntriesCount()
Returns the number of ratings entries.

Returns:
the number of ratings entries

getRatingsEntry

public static RatingsEntry getRatingsEntry(long entryId)
                                    throws PortalException
Returns the ratings entry with the primary key.

Parameters:
entryId - the primary key of the ratings entry
Returns:
the ratings entry
Throws:
PortalException - if a ratings entry with the primary key could not be found

getRatingsEntryByUuidAndCompanyId

public static RatingsEntry getRatingsEntryByUuidAndCompanyId(String uuid,
                                                             long companyId)
                                                      throws PortalException
Returns the ratings entry with the matching UUID and company.

Parameters:
uuid - the ratings entry's UUID
companyId - the primary key of the company
Returns:
the matching ratings entry
Throws:
PortalException - if a matching ratings entry could not be found

updateEntry

public static RatingsEntry updateEntry(long userId,
                                       String className,
                                       long classPK,
                                       double score,
                                       ServiceContext serviceContext)
                                throws PortalException
Throws:
PortalException

updateRatingsEntry

public static RatingsEntry updateRatingsEntry(RatingsEntry ratingsEntry)
Updates the ratings entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
ratingsEntry - the ratings entry
Returns:
the ratings entry that was updated

getService

public static RatingsEntryLocalService getService()

Liferay 7.0-ce-b4