com.liferay.portal.kernel.service

Interface WorkflowDefinitionLinkLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

WorkflowDefinitionLinkLocalServiceWrapper

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

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

WorkflowDefinitionLinkLocalServiceUtil, WorkflowDefinitionLinkLocalServiceBaseImpl, WorkflowDefinitionLinkLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
WorkflowDefinitionLink	addWorkflowDefinitionLink(long userId, long companyId, long groupId, String className, long classPK, long typePK, String workflowDefinitionName, int workflowDefinitionVersion)
WorkflowDefinitionLink	addWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink) Adds the workflow definition link to the database.
WorkflowDefinitionLink	createWorkflowDefinitionLink(long workflowDefinitionLinkId) Creates a new workflow definition link with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
WorkflowDefinitionLink	deleteWorkflowDefinitionLink(long workflowDefinitionLinkId) Deletes the workflow definition link with the primary key from the database.
void	deleteWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK, long typePK)
WorkflowDefinitionLink	deleteWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink) Deletes the workflow definition link from the database.
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
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.
WorkflowDefinitionLink	fetchDefaultWorkflowDefinitionLink(long companyId, String className, long classPK, long typePK)
WorkflowDefinitionLink	fetchWorkflowDefinitionLink(long workflowDefinitionLinkId)
WorkflowDefinitionLink	fetchWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK, long typePK)
WorkflowDefinitionLink	fetchWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK, long typePK, boolean strict)
ActionableDynamicQuery	getActionableDynamicQuery()
WorkflowDefinitionLink	getDefaultWorkflowDefinitionLink(long companyId, String className, long classPK, long typePK)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
WorkflowDefinitionLink	getWorkflowDefinitionLink(long workflowDefinitionLinkId) Returns the workflow definition link with the primary key.
WorkflowDefinitionLink	getWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK, long typePK)
WorkflowDefinitionLink	getWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK, long typePK, boolean strict)
List<WorkflowDefinitionLink>	getWorkflowDefinitionLinks(int start, int end) Returns a range of all the workflow definition links.
int	getWorkflowDefinitionLinksCount() Returns the number of workflow definition links.
int	getWorkflowDefinitionLinksCount(long companyId, long groupId, String className)
int	getWorkflowDefinitionLinksCount(long companyId, String workflowDefinitionName, int workflowDefinitionVersion)
boolean	hasWorkflowDefinitionLink(long companyId, long groupId, String className)
boolean	hasWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK)
boolean	hasWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK, long typePK)
void	updateWorkflowDefinitionLink(long userId, long companyId, long groupId, String className, long classPK, long typePK, String workflowDefinition)
WorkflowDefinitionLink	updateWorkflowDefinitionLink(long userId, long companyId, long groupId, String className, long classPK, long typePK, String workflowDefinitionName, int workflowDefinitionVersion)
WorkflowDefinitionLink	updateWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink) Updates the workflow definition link in the database or adds it if it does not yet exist.
void	updateWorkflowDefinitionLinks(long userId, long companyId, long groupId, String className, long classPK, List<ObjectValuePair<Long,String>> workflowDefinitionOVPs)

Method Detail

addWorkflowDefinitionLink

WorkflowDefinitionLink addWorkflowDefinitionLink(long userId,
                                                 long companyId,
                                                 long groupId,
                                                 String className,
                                                 long classPK,
                                                 long typePK,
                                                 String workflowDefinitionName,
                                                 int workflowDefinitionVersion)
                                          throws PortalException

Throws:

PortalException

addWorkflowDefinitionLink

@Indexable(type=REINDEX)
WorkflowDefinitionLink addWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink)

Adds the workflow definition link to the database. Also notifies the appropriate model listeners.

Parameters:

workflowDefinitionLink - the workflow definition link

Returns:

the workflow definition link that was added

createWorkflowDefinitionLink

@Transactional(enabled=false)
WorkflowDefinitionLink createWorkflowDefinitionLink(long workflowDefinitionLinkId)

Creates a new workflow definition link with the primary key. Does not add the workflow definition link to the database.

Parameters:

workflowDefinitionLinkId - the primary key for the new workflow definition link

Returns:

the new workflow definition link

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteWorkflowDefinitionLink

@Indexable(type=DELETE)
WorkflowDefinitionLink deleteWorkflowDefinitionLink(long workflowDefinitionLinkId)
                                                                     throws PortalException

Deletes the workflow definition link with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

workflowDefinitionLinkId - the primary key of the workflow definition link

Returns:

the workflow definition link that was removed

Throws:

PortalException - if a workflow definition link with the primary key could not be found

deleteWorkflowDefinitionLink

void deleteWorkflowDefinitionLink(long companyId,
                                  long groupId,
                                  String className,
                                  long classPK,
                                  long typePK)

deleteWorkflowDefinitionLink

@Indexable(type=DELETE)
WorkflowDefinitionLink deleteWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink)

Deletes the workflow definition link from the database. Also notifies the appropriate model listeners.

Parameters:

workflowDefinitionLink - the workflow definition link

Returns:

the workflow definition link that was removed

dynamicQuery

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

dynamicQuery

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

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

fetchDefaultWorkflowDefinitionLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowDefinitionLink fetchDefaultWorkflowDefinitionLink(long companyId,
                                                                                                                             String className,
                                                                                                                             long classPK,
                                                                                                                             long typePK)

fetchWorkflowDefinitionLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowDefinitionLink fetchWorkflowDefinitionLink(long workflowDefinitionLinkId)

fetchWorkflowDefinitionLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowDefinitionLink fetchWorkflowDefinitionLink(long companyId,
                                                                                                                      long groupId,
                                                                                                                      String className,
                                                                                                                      long classPK,
                                                                                                                      long typePK)

fetchWorkflowDefinitionLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowDefinitionLink fetchWorkflowDefinitionLink(long companyId,
                                                                                                                      long groupId,
                                                                                                                      String className,
                                                                                                                      long classPK,
                                                                                                                      long typePK,
                                                                                                                      boolean strict)

getActionableDynamicQuery

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

getDefaultWorkflowDefinitionLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowDefinitionLink getDefaultWorkflowDefinitionLink(long companyId,
                                                                                                                           String className,
                                                                                                                           long classPK,
                                                                                                                           long typePK)
                                                                                                                    throws PortalException

Throws:

PortalException

getIndexableActionableDynamicQuery

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

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getWorkflowDefinitionLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowDefinitionLink getWorkflowDefinitionLink(long workflowDefinitionLinkId)
                                                                                                             throws PortalException

Returns the workflow definition link with the primary key.

Parameters:

workflowDefinitionLinkId - the primary key of the workflow definition link

Returns:

the workflow definition link

Throws:

PortalException - if a workflow definition link with the primary key could not be found

getWorkflowDefinitionLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowDefinitionLink getWorkflowDefinitionLink(long companyId,
                                                                                                                    long groupId,
                                                                                                                    String className,
                                                                                                                    long classPK,
                                                                                                                    long typePK)
                                                                                                             throws PortalException

Throws:

PortalException

getWorkflowDefinitionLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowDefinitionLink getWorkflowDefinitionLink(long companyId,
                                                                                                                    long groupId,
                                                                                                                    String className,
                                                                                                                    long classPK,
                                                                                                                    long typePK,
                                                                                                                    boolean strict)
                                                                                                             throws PortalException

Throws:

PortalException

getWorkflowDefinitionLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WorkflowDefinitionLink> getWorkflowDefinitionLinks(int start,
                                                                                                                           int end)

Returns a range of all the workflow definition 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 WorkflowDefinitionLinkModelImpl. 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 definition links

end - the upper bound of the range of workflow definition links (not inclusive)

Returns:

the range of workflow definition links

getWorkflowDefinitionLinksCount

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

Returns the number of workflow definition links.

Returns:

the number of workflow definition links

getWorkflowDefinitionLinksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWorkflowDefinitionLinksCount(long companyId,
                                                                                                       long groupId,
                                                                                                       String className)

getWorkflowDefinitionLinksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWorkflowDefinitionLinksCount(long companyId,
                                                                                                       String workflowDefinitionName,
                                                                                                       int workflowDefinitionVersion)

hasWorkflowDefinitionLink

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasWorkflowDefinitionLink(long companyId,
                                                                                                            long groupId,
                                                                                                            String className)

hasWorkflowDefinitionLink

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasWorkflowDefinitionLink(long companyId,
                                                                                                            long groupId,
                                                                                                            String className,
                                                                                                            long classPK)

hasWorkflowDefinitionLink

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasWorkflowDefinitionLink(long companyId,
                                                                                                            long groupId,
                                                                                                            String className,
                                                                                                            long classPK,
                                                                                                            long typePK)

updateWorkflowDefinitionLink

void updateWorkflowDefinitionLink(long userId,
                                  long companyId,
                                  long groupId,
                                  String className,
                                  long classPK,
                                  long typePK,
                                  String workflowDefinition)
                           throws PortalException

Throws:

PortalException

updateWorkflowDefinitionLink

WorkflowDefinitionLink updateWorkflowDefinitionLink(long userId,
                                                    long companyId,
                                                    long groupId,
                                                    String className,
                                                    long classPK,
                                                    long typePK,
                                                    String workflowDefinitionName,
                                                    int workflowDefinitionVersion)
                                             throws PortalException

Throws:

PortalException

updateWorkflowDefinitionLink

@Indexable(type=REINDEX)
WorkflowDefinitionLink updateWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink)

Updates the workflow definition link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

workflowDefinitionLink - the workflow definition link

Returns:

the workflow definition link that was updated

updateWorkflowDefinitionLinks

void updateWorkflowDefinitionLinks(long userId,
                                   long companyId,
                                   long groupId,
                                   String className,
                                   long classPK,
                                   List<ObjectValuePair<Long,String>> workflowDefinitionOVPs)
                            throws PortalException

Throws:

PortalException