Liferay 6.2-ce-ga5

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 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 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
static RatingsEntry fetchEntry(long userId, String className, long classPK)
           
static RatingsEntry fetchRatingsEntry(long entryId)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
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 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 RatingsEntryLocalService getService()
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(RatingsEntryLocalService service)
          Deprecated. As of 6.2.0
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)
                                    throws SystemException
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
Throws:
SystemException - if a system exception occurred

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

deleteRatingsEntry

public static RatingsEntry deleteRatingsEntry(long entryId)
                                       throws PortalException,
                                              SystemException
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
SystemException - if a system exception occurred

deleteRatingsEntry

public static RatingsEntry deleteRatingsEntry(RatingsEntry ratingsEntry)
                                       throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

dynamicQuery

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

dynamicQueryCount

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

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

fetchRatingsEntry

public static RatingsEntry fetchRatingsEntry(long entryId)
                                      throws SystemException
Throws:
SystemException

getRatingsEntry

public static RatingsEntry getRatingsEntry(long entryId)
                                    throws PortalException,
                                           SystemException
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
SystemException - if a system exception occurred

getPersistedModel

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

getRatingsEntries

public static List<RatingsEntry> getRatingsEntries(int start,
                                                   int end)
                                            throws SystemException
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
Throws:
SystemException - if a system exception occurred

getRatingsEntriesCount

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

Returns:
the number of ratings entries
Throws:
SystemException - if a system exception occurred

updateRatingsEntry

public static RatingsEntry updateRatingsEntry(RatingsEntry ratingsEntry)
                                       throws SystemException
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
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

deleteEntry

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

fetchEntry

public static RatingsEntry fetchEntry(long userId,
                                      String className,
                                      long classPK)
                               throws SystemException
Throws:
SystemException

getEntries

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

getEntries

public static List<RatingsEntry> getEntries(String className,
                                            long classPK)
                                     throws SystemException
Throws:
SystemException

getEntries

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

getEntriesCount

public static int getEntriesCount(String className,
                                  long classPK,
                                  double score)
                           throws SystemException
Throws:
SystemException

getEntry

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

updateEntry

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

getService

public static RatingsEntryLocalService getService()

setService

public void setService(RatingsEntryLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5