com.liferay.portal.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, WorkflowInstanceLinkLocalServiceBaseImpl, com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl

Generated:

Method Summary

Methods

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.
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()
java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
WorkflowInstanceLink	fetchWorkflowInstanceLink(long workflowInstanceLinkId)
WorkflowInstanceLink	fetchWorkflowInstanceLink(long companyId, long groupId, java.lang.String className, long classPK)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
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

@Indexable(type=REINDEX)
WorkflowInstanceLink addWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
                                             throws SystemException

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

Throws:

SystemException - if a system exception occurred

createWorkflowInstanceLink

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

deleteWorkflowInstanceLink

@Indexable(type=DELETE)
WorkflowInstanceLink deleteWorkflowInstanceLink(long workflowInstanceLinkId)
                                                throws PortalException,
                                                       SystemException

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

SystemException - if a system exception occurred

deleteWorkflowInstanceLink

@Indexable(type=DELETE)
WorkflowInstanceLink deleteWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
                                                throws PortalException,
                                                       SystemException

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

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                            throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end)
                            throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end,
                          OrderByComparator orderByComparator)
                            throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchWorkflowInstanceLink

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

Throws:

SystemException

getWorkflowInstanceLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowInstanceLink getWorkflowInstanceLink(long workflowInstanceLinkId)
                                             throws PortalException,
                                                    SystemException

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

SystemException - if a system exception occurred

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getWorkflowInstanceLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WorkflowInstanceLink> getWorkflowInstanceLinks(int start,
                                                                                                     int end)
                                                              throws SystemException

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

Throws:

SystemException - if a system exception occurred

getWorkflowInstanceLinksCount

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

Returns the number of workflow instance links.

Returns:

the number of workflow instance links

Throws:

SystemException - if a system exception occurred

updateWorkflowInstanceLink

@Indexable(type=REINDEX)
WorkflowInstanceLink updateWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
                                                throws SystemException

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

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addWorkflowInstanceLink

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

Throws:

PortalException

SystemException

deleteWorkflowInstanceLink

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

Throws:

PortalException

SystemException

deleteWorkflowInstanceLinks

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

Throws:

PortalException

SystemException

fetchWorkflowInstanceLink

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

Throws:

SystemException

getState

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

Throws:

PortalException

SystemException

getWorkflowInstanceLink

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

Throws:

PortalException

SystemException

getWorkflowInstanceLinks

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

Throws:

SystemException

hasWorkflowInstanceLink

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

Throws:

SystemException

isEnded

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

Throws:

PortalException

SystemException

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,
                                  SystemException

Throws:

PortalException

SystemException

updateClassPK

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

Throws:

PortalException

SystemException