Class ObjectActionLocalServiceUtil

java.lang.Object
com.liferay.object.service.ObjectActionLocalServiceUtil

public class ObjectActionLocalServiceUtil extends Object
Provides the local service utility for ObjectAction. This utility wraps com.liferay.object.service.impl.ObjectActionLocalServiceImpl and is an 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:
Generated:
  • Constructor Details

    • ObjectActionLocalServiceUtil

      public ObjectActionLocalServiceUtil()
  • Method Details

    • addObjectAction

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

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

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

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

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectAction

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

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

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

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

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

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

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

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

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

      public static ObjectAction fetchObjectAction(long objectActionId)
    • fetchObjectAction

      public static ObjectAction fetchObjectAction(String externalReferenceCode, long objectDefinitionId)
    • fetchObjectActionByUuidAndCompanyId

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

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getObjectAction

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

      public static ObjectAction getObjectAction(long objectDefinitionId, String name, String objectActionTriggerKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectActionByUuidAndCompanyId

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

      public static List<ObjectAction> getObjectActions(boolean active, String objectActionExecutorKey)
    • getObjectActions

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

      public static List<ObjectAction> getObjectActions(long objectDefinitionId)
    • getObjectActions

      public static List<ObjectAction> getObjectActions(long objectDefinitionId, String objectActionTriggerKey)
    • getObjectActionsCount

      public static int getObjectActionsCount()
      Returns the number of object actions.
      Returns:
      the number of object actions
    • getObjectActionsMap

      public static Map<Long,List<ObjectAction>> getObjectActionsMap(long companyId, boolean active, String objectActionTriggerKey)
    • getOSGiServiceIdentifier

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateObjectAction

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

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

      public static ObjectAction updateStatus(long objectActionId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static ObjectActionLocalService getService()