com.liferay.portal.kernel.service

Interface WorkflowInstanceLinkLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

WorkflowInstanceLinkLocalServiceWrapper

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

Provides the local service interface for WorkflowInstanceLink. 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:

WorkflowInstanceLinkLocalServiceUtil

Generated:

Method Summary

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

Method Detail

addWorkflowInstanceLink

WorkflowInstanceLink addWorkflowInstanceLink(long userId,
                                             long companyId,
                                             long groupId,
                                             java.lang.String className,
                                             long classPK,
                                             long workflowInstanceId)
                                      throws PortalException

Throws:

PortalException

addWorkflowInstanceLink

@Indexable(type=REINDEX)
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

@Transactional(enabled=false)
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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteWorkflowInstanceLink

@Indexable(type=DELETE)
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

WorkflowInstanceLink deleteWorkflowInstanceLink(long companyId,
                                                long groupId,
                                                java.lang.String className,
                                                long classPK)
                                         throws PortalException

Throws:

PortalException

deleteWorkflowInstanceLink

@Indexable(type=DELETE)
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

void deleteWorkflowInstanceLinks(long companyId,
                                 long groupId,
                                 java.lang.String className,
                                 long classPK)
                          throws PortalException

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowInstanceLink fetchWorkflowInstanceLink(long workflowInstanceLinkId)

fetchWorkflowInstanceLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowInstanceLink fetchWorkflowInstanceLink(long companyId,
                                                                                                                  long groupId,
                                                                                                                  java.lang.String className,
                                                                                                                  long classPK)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getState

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String getState(long companyId,
                                                                                             long groupId,
                                                                                             java.lang.String className,
                                                                                             long classPK)
                                                                                      throws PortalException

Throws:

PortalException

getWorkflowInstanceLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowInstanceLink getWorkflowInstanceLink(long companyId,
                                                                                                                long groupId,
                                                                                                                java.lang.String className,
                                                                                                                long classPK)
                                                                                                         throws PortalException

Throws:

PortalException

getWorkflowInstanceLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WorkflowInstanceLink> getWorkflowInstanceLinks(long companyId,
                                                                                                                                 long groupId,
                                                                                                                                 java.lang.String className,
                                                                                                                                 long classPK)

getWorkflowInstanceLinksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWorkflowInstanceLinksCount()

Returns the number of workflow instance links.

Returns:

the number of workflow instance links

hasWorkflowInstanceLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasWorkflowInstanceLink(long companyId,
                                                                                                   long groupId,
                                                                                                   java.lang.String className,
                                                                                                   long classPK)

isEnded

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isEnded(long companyId,
                                                                                   long groupId,
                                                                                   java.lang.String className,
                                                                                   long classPK)
                                                                            throws PortalException

Throws:

PortalException

startWorkflowInstance

void startWorkflowInstance(long companyId,
                           long groupId,
                           long userId,
                           java.lang.String className,
                           long classPK,
                           java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
                    throws PortalException

Throws:

PortalException

updateClassPK

void updateClassPK(long companyId,
                   long groupId,
                   java.lang.String className,
                   long oldClassPK,
                   long newClassPK)
            throws PortalException

Throws:

PortalException

updateWorkflowInstanceLink

@Indexable(type=REINDEX)
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