Interface ObjectActionLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
ObjectActionLocalServiceWrapper

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface ObjectActionLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for ObjectAction. 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:
Generated:
  • Method Details

    • addObjectAction

      @Indexable(type=REINDEX) ObjectAction addObjectAction(ObjectAction objectAction)
      Adds the object action to the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectActionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      objectAction - the object action
      Returns:
      the object action that was added
    • addObjectAction

      @Indexable(type=REINDEX) ObjectAction addObjectAction(String externalReferenceCode, long userId, long objectDefinitionId, boolean active, String conditionExpression, String description, Map<Locale,String> errorMessageMap, Map<Locale,String> labelMap, String name, String objectActionExecutorKey, String objectActionTriggerKey, com.liferay.portal.kernel.util.UnicodeProperties parametersUnicodeProperties, boolean system) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateObjectAction

      @Indexable(type=REINDEX) ObjectAction addOrUpdateObjectAction(String externalReferenceCode, long objectActionId, long userId, long objectDefinitionId, boolean active, String conditionExpression, String description, Map<Locale,String> errorMessageMap, Map<Locale,String> labelMap, String name, String objectActionExecutorKey, String objectActionTriggerKey, com.liferay.portal.kernel.util.UnicodeProperties parametersUnicodeProperties, boolean system) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createObjectAction

      @Transactional(enabled=false) ObjectAction createObjectAction(long objectActionId)
      Creates a new object action with the primary key. Does not add the object action to the database.
      Parameters:
      objectActionId - the primary key for the new object action
      Returns:
      the new object action
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectAction

      @Indexable(type=DELETE) ObjectAction deleteObjectAction(long objectActionId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object action with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectActionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      objectActionId - the primary key of the object action
      Returns:
      the object action that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object action with the primary key could not be found
    • deleteObjectAction

      @Indexable(type=DELETE) @SystemEvent(type=1) ObjectAction deleteObjectAction(ObjectAction objectAction) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object action from the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectActionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      objectAction - the object action
      Returns:
      the object action that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectActions

      void deleteObjectActions(long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePersistedModel

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectActionModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectActionModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.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
    • fetchObjectAction

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectAction fetchObjectAction(long objectActionId)
    • fetchObjectAction

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectAction fetchObjectAction(String externalReferenceCode, long objectDefinitionId)
    • fetchObjectActionByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectAction fetchObjectActionByUuidAndCompanyId(String uuid, long companyId)
      Returns the object action with the matching UUID and company.
      Parameters:
      uuid - the object action's UUID
      companyId - the primary key of the company
      Returns:
      the matching object action, or null if a matching object action could not be found
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getObjectAction

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectAction getObjectAction(long objectActionId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object action with the primary key.
      Parameters:
      objectActionId - the primary key of the object action
      Returns:
      the object action
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object action with the primary key could not be found
    • getObjectAction

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectAction getObjectAction(long objectDefinitionId, String name, String objectActionTriggerKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectActionByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectAction getObjectActionByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object action with the matching UUID and company.
      Parameters:
      uuid - the object action's UUID
      companyId - the primary key of the company
      Returns:
      the matching object action
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching object action could not be found
    • getObjectActions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectAction> getObjectActions(boolean active, String objectActionExecutorKey)
    • getObjectActions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectAction> getObjectActions(int start, int end)
      Returns a range of all the object actions.

      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectActionModelImpl.

      Parameters:
      start - the lower bound of the range of object actions
      end - the upper bound of the range of object actions (not inclusive)
      Returns:
      the range of object actions
    • getObjectActions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectAction> getObjectActions(long objectDefinitionId)
    • getObjectActions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectAction> getObjectActions(long objectDefinitionId, String objectActionTriggerKey)
    • getObjectActionsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectActionsCount()
      Returns the number of object actions.
      Returns:
      the number of object actions
    • getObjectActionsMap

      @Transactional(propagation=SUPPORTS, readOnly=true) Map<Long,List<ObjectAction>> getObjectActionsMap(long companyId, boolean active, String objectActionTriggerKey)
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateObjectAction

      @Indexable(type=REINDEX) ObjectAction updateObjectAction(ObjectAction objectAction)
      Updates the object action in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect ObjectActionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      objectAction - the object action
      Returns:
      the object action that was updated
    • updateObjectAction

      @Indexable(type=REINDEX) ObjectAction updateObjectAction(String externalReferenceCode, long objectActionId, boolean active, String conditionExpression, String description, Map<Locale,String> errorMessageMap, Map<Locale,String> labelMap, String name, String objectActionExecutorKey, String objectActionTriggerKey, com.liferay.portal.kernel.util.UnicodeProperties parametersUnicodeProperties) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStatus

      @Indexable(type=REINDEX) ObjectAction updateStatus(long objectActionId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException