com.liferay.portal.kernel.service

Class WorkflowInstanceLinkLocalServiceUtil

Object

com.liferay.portal.kernel.service.WorkflowInstanceLinkLocalServiceUtil

@ProviderType
public class WorkflowInstanceLinkLocalServiceUtil
extends Object

Provides the local service utility for WorkflowInstanceLink. This utility wraps WorkflowInstanceLinkLocalServiceImpl and is the primary 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:

WorkflowInstanceLinkLocalService, WorkflowInstanceLinkLocalServiceBaseImpl, WorkflowInstanceLinkLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
WorkflowInstanceLinkLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static WorkflowInstanceLink	addWorkflowInstanceLink(long userId, long companyId, long groupId, String className, long classPK, long workflowInstanceId)
static WorkflowInstanceLink	addWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink) Adds the workflow instance link to the database.
static WorkflowInstanceLink	createWorkflowInstanceLink(long workflowInstanceLinkId) Creates a new workflow instance link with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static WorkflowInstanceLink	deleteWorkflowInstanceLink(long workflowInstanceLinkId) Deletes the workflow instance link with the primary key from the database.
static WorkflowInstanceLink	deleteWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
static WorkflowInstanceLink	deleteWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink) Deletes the workflow instance link from the database.
static void	deleteWorkflowInstanceLinks(long companyId, long groupId, String className, long classPK)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
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.
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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static WorkflowInstanceLink	fetchWorkflowInstanceLink(long workflowInstanceLinkId)
static WorkflowInstanceLink	fetchWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static WorkflowInstanceLinkLocalService	getService()
static String	getState(long companyId, long groupId, String className, long classPK)
static WorkflowInstanceLink	getWorkflowInstanceLink(long workflowInstanceLinkId) Returns the workflow instance link with the primary key.
static WorkflowInstanceLink	getWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
static List<WorkflowInstanceLink>	getWorkflowInstanceLinks(int start, int end) Returns a range of all the workflow instance links.
static List<WorkflowInstanceLink>	getWorkflowInstanceLinks(long companyId, long groupId, String className, long classPK)
static int	getWorkflowInstanceLinksCount() Returns the number of workflow instance links.
static boolean	hasWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
static boolean	isEnded(long companyId, long groupId, String className, long classPK)
static void	startWorkflowInstance(long companyId, long groupId, long userId, String className, long classPK, Map<String,Serializable> workflowContext)
static void	updateClassPK(long companyId, long groupId, String className, long oldClassPK, long newClassPK)
static WorkflowInstanceLink	updateWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink) Updates the workflow instance link in the database or adds it if it does not yet exist.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowInstanceLinkLocalServiceUtil

public WorkflowInstanceLinkLocalServiceUtil()

Method Detail

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.

Parameters:

workflowInstanceLink - the workflow instance link

Returns:

the workflow instance link that was added

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.

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.

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

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 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 WorkflowInstanceLinkModelImpl. 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

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 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 WorkflowInstanceLinkModelImpl. 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

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 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 WorkflowInstanceLinkModelImpl. 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 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

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.

Parameters:

workflowInstanceLink - the workflow instance link

Returns:

the workflow instance link that was updated

getService

public static WorkflowInstanceLinkLocalService getService()