Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface SystemEventLocalService

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

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

Provides the local service interface for SystemEvent. 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:
SystemEventLocalServiceUtil, SystemEventLocalServiceBaseImpl, com.liferay.portal.service.impl.SystemEventLocalServiceImpl

Method Summary
 SystemEvent addSystemEvent(long userId, long groupId, String className, long classPK, String classUuid, String referrerClassName, int type, String extraData)
           
 SystemEvent addSystemEvent(long companyId, String className, long classPK, String classUuid, String referrerClassName, int type, String extraData)
           
 SystemEvent addSystemEvent(SystemEvent systemEvent)
          Adds the system event to the database.
 SystemEvent createSystemEvent(long systemEventId)
          Creates a new system event with the primary key.
 SystemEvent deleteSystemEvent(long systemEventId)
          Deletes the system event with the primary key from the database.
 SystemEvent deleteSystemEvent(SystemEvent systemEvent)
          Deletes the system event from the database.
 void deleteSystemEvents(long groupId)
           
 void deleteSystemEvents(long groupId, long systemEventSetKey)
           
 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.
 SystemEvent fetchSystemEvent(long systemEventId)
           
 SystemEvent fetchSystemEvent(long groupId, long classNameId, long classPK, int type)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 SystemEvent getSystemEvent(long systemEventId)
          Returns the system event with the primary key.
 List<SystemEvent> getSystemEvents(int start, int end)
          Returns a range of all the system events.
 List<SystemEvent> getSystemEvents(long groupId, long classNameId, long classPK)
           
 List<SystemEvent> getSystemEvents(long groupId, long classNameId, long classPK, int type)
           
 int getSystemEventsCount()
          Returns the number of system events.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 SystemEvent updateSystemEvent(SystemEvent systemEvent)
          Updates the system event in the database or adds it if it does not yet exist.
 

Method Detail

addSystemEvent

@Indexable(type=REINDEX)
SystemEvent addSystemEvent(SystemEvent systemEvent)
                           throws SystemException
Adds the system event to the database. Also notifies the appropriate model listeners.

Parameters:
systemEvent - the system event
Returns:
the system event that was added
Throws:
SystemException - if a system exception occurred

createSystemEvent

SystemEvent createSystemEvent(long systemEventId)
Creates a new system event with the primary key. Does not add the system event to the database.

Parameters:
systemEventId - the primary key for the new system event
Returns:
the new system event

deleteSystemEvent

@Indexable(type=DELETE)
SystemEvent deleteSystemEvent(long systemEventId)
                              throws PortalException,
                                     SystemException
Deletes the system event with the primary key from the database. Also notifies the appropriate model listeners.

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

deleteSystemEvent

@Indexable(type=DELETE)
SystemEvent deleteSystemEvent(SystemEvent systemEvent)
                              throws SystemException
Deletes the system event from the database. Also notifies the appropriate model listeners.

Parameters:
systemEvent - the system event
Returns:
the system event 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 SystemEventModelImpl. 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 SystemEventModelImpl. 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

fetchSystemEvent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SystemEvent fetchSystemEvent(long systemEventId)
                             throws SystemException
Throws:
SystemException

getSystemEvent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SystemEvent getSystemEvent(long systemEventId)
                           throws PortalException,
                                  SystemException
Returns the system event with the primary key.

Parameters:
systemEventId - the primary key of the system event
Returns:
the system event
Throws:
PortalException - if a system event 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

getSystemEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SystemEvent> getSystemEvents(int start,
                                                                           int end)
                                  throws SystemException
Returns a range of all the system events.

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

getSystemEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSystemEventsCount()
                         throws SystemException
Returns the number of system events.

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

updateSystemEvent

@Indexable(type=REINDEX)
SystemEvent updateSystemEvent(SystemEvent systemEvent)
                              throws SystemException
Updates the system event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
systemEvent - the system event
Returns:
the system event 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

addSystemEvent

SystemEvent addSystemEvent(long userId,
                           long groupId,
                           String className,
                           long classPK,
                           String classUuid,
                           String referrerClassName,
                           int type,
                           String extraData)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

addSystemEvent

SystemEvent addSystemEvent(long companyId,
                           String className,
                           long classPK,
                           String classUuid,
                           String referrerClassName,
                           int type,
                           String extraData)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

deleteSystemEvents

void deleteSystemEvents(long groupId)
                        throws SystemException
Throws:
SystemException

deleteSystemEvents

void deleteSystemEvents(long groupId,
                        long systemEventSetKey)
                        throws SystemException
Throws:
SystemException

fetchSystemEvent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SystemEvent fetchSystemEvent(long groupId,
                                                                      long classNameId,
                                                                      long classPK,
                                                                      int type)
                             throws SystemException
Throws:
SystemException

getSystemEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SystemEvent> getSystemEvents(long groupId,
                                                                           long classNameId,
                                                                           long classPK)
                                  throws SystemException
Throws:
SystemException

getSystemEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SystemEvent> getSystemEvents(long groupId,
                                                                           long classNameId,
                                                                           long classPK,
                                                                           int type)
                                  throws SystemException
Throws:
SystemException

Liferay 6.2-ce-ga5