Class WorkflowInstanceLinkLocalServiceUtil

Object
com.liferay.portal.kernel.service.WorkflowInstanceLinkLocalServiceUtil

public class WorkflowInstanceLinkLocalServiceUtil extends Object
Provides the local service utility for WorkflowInstanceLink. This utility wraps com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl 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.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • WorkflowInstanceLinkLocalServiceUtil

      public WorkflowInstanceLinkLocalServiceUtil()
  • Method Details

    • addWorkflowInstanceLink

      public static WorkflowInstanceLink addWorkflowInstanceLink(long userId, long companyId, long groupId, String className, long classPK, long workflowInstanceId) throws PortalException
      Throws:
      PortalException
    • addWorkflowInstanceLink

      public static WorkflowInstanceLink addWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
      Adds the workflow instance link to the database. Also notifies the appropriate model listeners.

      Important: Inspect WorkflowInstanceLinkLocalServiceImpl 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:
      workflowInstanceLink - the workflow instance link
      Returns:
      the workflow instance link that was added
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • createWorkflowInstanceLink

      public static WorkflowInstanceLink createWorkflowInstanceLink(long workflowInstanceLinkId)
      Creates a new workflow instance link with the primary key. Does not add the workflow instance link to the database.
      Parameters:
      workflowInstanceLinkId - the primary key for the new workflow instance link
      Returns:
      the new workflow instance link
    • deletePersistedModel

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deleteWorkflowInstanceLink

      public static WorkflowInstanceLink deleteWorkflowInstanceLink(long workflowInstanceLinkId) throws PortalException
      Deletes the workflow instance link with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect WorkflowInstanceLinkLocalServiceImpl 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:
      workflowInstanceLinkId - the primary key of the workflow instance link
      Returns:
      the workflow instance link that was removed
      Throws:
      PortalException - if a workflow instance link with the primary key could not be found
    • deleteWorkflowInstanceLink

      public static WorkflowInstanceLink deleteWorkflowInstanceLink(long companyId, long groupId, String className, long classPK) throws PortalException
      Throws:
      PortalException
    • deleteWorkflowInstanceLink

      public static WorkflowInstanceLink deleteWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink) throws PortalException
      Deletes the workflow instance link from the database. Also notifies the appropriate model listeners.

      Important: Inspect WorkflowInstanceLinkLocalServiceImpl 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:
      workflowInstanceLink - the workflow instance link
      Returns:
      the workflow instance link that was removed
      Throws:
      PortalException
    • deleteWorkflowInstanceLinks

      public static void deleteWorkflowInstanceLinks(long companyId, long groupId, String className, long classPK) throws PortalException
      Throws:
      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 DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(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(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.portal.model.impl.WorkflowInstanceLinkModelImpl.

      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(DynamicQuery dynamicQuery, int start, int end, 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.portal.model.impl.WorkflowInstanceLinkModelImpl.

      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(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(DynamicQuery dynamicQuery, 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
    • fetchWorkflowInstanceLink

      public static WorkflowInstanceLink fetchWorkflowInstanceLink(long workflowInstanceLinkId)
    • fetchWorkflowInstanceLink

      public static WorkflowInstanceLink fetchWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getState

      public static String getState(long companyId, long groupId, String className, long classPK) throws PortalException
      Throws:
      PortalException
    • getWorkflowInstanceLink

      public static WorkflowInstanceLink getWorkflowInstanceLink(long workflowInstanceLinkId) throws PortalException
      Returns the workflow instance link with the primary key.
      Parameters:
      workflowInstanceLinkId - the primary key of the workflow instance link
      Returns:
      the workflow instance link
      Throws:
      PortalException - if a workflow instance link with the primary key could not be found
    • getWorkflowInstanceLink

      public static WorkflowInstanceLink getWorkflowInstanceLink(long companyId, long groupId, String className, long classPK) throws PortalException
      Throws:
      PortalException
    • getWorkflowInstanceLinks

      public static List<WorkflowInstanceLink> getWorkflowInstanceLinks(int start, int end)
      Returns a range of all the workflow instance links.

      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.portal.model.impl.WorkflowInstanceLinkModelImpl.

      Parameters:
      start - the lower bound of the range of workflow instance links
      end - the upper bound of the range of workflow instance links (not inclusive)
      Returns:
      the range of workflow instance links
    • getWorkflowInstanceLinks

      public static List<WorkflowInstanceLink> getWorkflowInstanceLinks(long companyId, long groupId, String className, long classPK)
    • getWorkflowInstanceLinksCount

      public static int getWorkflowInstanceLinksCount()
      Returns the number of workflow instance links.
      Returns:
      the number of workflow instance links
    • hasWorkflowInstanceLink

      public static boolean hasWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
    • isEnded

      public static boolean isEnded(long companyId, long groupId, String className, long classPK) throws PortalException
      Throws:
      PortalException
    • startWorkflowInstance

      public static void startWorkflowInstance(long companyId, long groupId, long userId, String className, long classPK, Map<String,Serializable> workflowContext) throws PortalException
      Throws:
      PortalException
    • startWorkflowInstance

      public static void startWorkflowInstance(long companyId, long groupId, long userId, String className, long classPK, Map<String,Serializable> workflowContext, boolean waitForCompletion) throws PortalException
      Throws:
      PortalException
    • updateClassPK

      public static void updateClassPK(long companyId, long groupId, String className, long oldClassPK, long newClassPK) throws PortalException
      Throws:
      PortalException
    • updateWorkflowInstanceLink

      public static WorkflowInstanceLink updateWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
      Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect WorkflowInstanceLinkLocalServiceImpl 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:
      workflowInstanceLink - the workflow instance link
      Returns:
      the workflow instance link that was updated
    • getService

      public static WorkflowInstanceLinkLocalService getService()
    • setService

      public static void setService(WorkflowInstanceLinkLocalService service)