Liferay 6.2-ce-ga5

com.liferay.portlet.polls.service
Interface PollsChoiceLocalService

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

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

Provides the local service interface for PollsChoice. 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:
PollsChoiceLocalServiceUtil, com.liferay.portlet.polls.service.base.PollsChoiceLocalServiceBaseImpl, com.liferay.portlet.polls.service.impl.PollsChoiceLocalServiceImpl

Method Summary
 PollsChoice addChoice(long userId, long questionId, String name, String description, ServiceContext serviceContext)
           
 PollsChoice addPollsChoice(PollsChoice pollsChoice)
          Adds the polls choice to the database.
 PollsChoice createPollsChoice(long choiceId)
          Creates a new polls choice with the primary key.
 PollsChoice deletePollsChoice(long choiceId)
          Deletes the polls choice with the primary key from the database.
 PollsChoice deletePollsChoice(PollsChoice pollsChoice)
          Deletes the polls choice 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.
 PollsChoice fetchPollsChoice(long choiceId)
           
 PollsChoice fetchPollsChoiceByUuidAndCompanyId(String uuid, long companyId)
          Returns the polls choice with the matching UUID and company.
 PollsChoice fetchPollsChoiceByUuidAndGroupId(String uuid, long groupId)
          Returns the polls choice matching the UUID and group.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PollsChoice getChoice(long choiceId)
           
 List<PollsChoice> getChoices(long questionId)
           
 int getChoicesCount(long questionId)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 PollsChoice getPollsChoice(long choiceId)
          Returns the polls choice with the primary key.
 PollsChoice getPollsChoiceByUuidAndCompanyId(String uuid, long companyId)
          Returns the polls choice with the matching UUID and company.
 PollsChoice getPollsChoiceByUuidAndGroupId(String uuid, long groupId)
          Returns the polls choice matching the UUID and group.
 List<PollsChoice> getPollsChoices(int start, int end)
          Returns a range of all the polls choices.
 int getPollsChoicesCount()
          Returns the number of polls choices.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 PollsChoice updateChoice(long choiceId, long questionId, String name, String description, ServiceContext serviceContext)
           
 PollsChoice updatePollsChoice(PollsChoice pollsChoice)
          Updates the polls choice in the database or adds it if it does not yet exist.
 

Method Detail

addPollsChoice

@Indexable(type=REINDEX)
PollsChoice addPollsChoice(PollsChoice pollsChoice)
                           throws SystemException
Adds the polls choice to the database. Also notifies the appropriate model listeners.

Parameters:
pollsChoice - the polls choice
Returns:
the polls choice that was added
Throws:
SystemException - if a system exception occurred

createPollsChoice

PollsChoice createPollsChoice(long choiceId)
Creates a new polls choice with the primary key. Does not add the polls choice to the database.

Parameters:
choiceId - the primary key for the new polls choice
Returns:
the new polls choice

deletePollsChoice

@Indexable(type=DELETE)
PollsChoice deletePollsChoice(long choiceId)
                              throws PortalException,
                                     SystemException
Deletes the polls choice with the primary key from the database. Also notifies the appropriate model listeners.

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

deletePollsChoice

@Indexable(type=DELETE)
PollsChoice deletePollsChoice(PollsChoice pollsChoice)
                              throws SystemException
Deletes the polls choice from the database. Also notifies the appropriate model listeners.

Parameters:
pollsChoice - the polls choice
Returns:
the polls choice 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 PollsChoiceModelImpl. 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 PollsChoiceModelImpl. 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

fetchPollsChoice

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PollsChoice fetchPollsChoice(long choiceId)
                             throws SystemException
Throws:
SystemException

fetchPollsChoiceByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PollsChoice fetchPollsChoiceByUuidAndCompanyId(String uuid,
                                                                                        long companyId)
                                               throws SystemException
Returns the polls choice with the matching UUID and company.

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

fetchPollsChoiceByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PollsChoice fetchPollsChoiceByUuidAndGroupId(String uuid,
                                                                                      long groupId)
                                             throws SystemException
Returns the polls choice matching the UUID and group.

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

getPollsChoice

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PollsChoice getPollsChoice(long choiceId)
                           throws PortalException,
                                  SystemException
Returns the polls choice with the primary key.

Parameters:
choiceId - the primary key of the polls choice
Returns:
the polls choice
Throws:
PortalException - if a polls choice 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

getPollsChoiceByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PollsChoice getPollsChoiceByUuidAndCompanyId(String uuid,
                                                                                      long companyId)
                                             throws PortalException,
                                                    SystemException
Returns the polls choice with the matching UUID and company.

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

getPollsChoiceByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PollsChoice getPollsChoiceByUuidAndGroupId(String uuid,
                                                                                    long groupId)
                                           throws PortalException,
                                                  SystemException
Returns the polls choice matching the UUID and group.

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

getPollsChoices

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PollsChoice> getPollsChoices(int start,
                                                                           int end)
                                  throws SystemException
Returns a range of all the polls choices.

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 PollsChoiceModelImpl. 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 polls choices
end - the upper bound of the range of polls choices (not inclusive)
Returns:
the range of polls choices
Throws:
SystemException - if a system exception occurred

getPollsChoicesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPollsChoicesCount()
                         throws SystemException
Returns the number of polls choices.

Returns:
the number of polls choices
Throws:
SystemException - if a system exception occurred

updatePollsChoice

@Indexable(type=REINDEX)
PollsChoice updatePollsChoice(PollsChoice pollsChoice)
                              throws SystemException
Updates the polls choice in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
pollsChoice - the polls choice
Returns:
the polls choice 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

addChoice

PollsChoice addChoice(long userId,
                      long questionId,
                      String name,
                      String description,
                      ServiceContext serviceContext)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getChoice

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PollsChoice getChoice(long choiceId)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getChoices

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PollsChoice> getChoices(long questionId)
                             throws SystemException
Throws:
SystemException

getChoicesCount

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

updateChoice

PollsChoice updateChoice(long choiceId,
                         long questionId,
                         String name,
                         String description,
                         ServiceContext serviceContext)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5