Class WorkflowDefinitionLinkLocalServiceUtil
com.liferay.portal.service.impl.WorkflowDefinitionLinkLocalServiceImpl
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic WorkflowDefinitionLink
addWorkflowDefinitionLink
(long userId, long companyId, long groupId, String className, long classPK, long typePK, String workflowDefinitionName, int workflowDefinitionVersion) static WorkflowDefinitionLink
addWorkflowDefinitionLink
(WorkflowDefinitionLink workflowDefinitionLink) Adds the workflow definition link to the database.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static WorkflowDefinitionLink
createWorkflowDefinitionLink
(long workflowDefinitionLinkId) Creates a new workflow definition link with the primary key.static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static WorkflowDefinitionLink
deleteWorkflowDefinitionLink
(long workflowDefinitionLinkId) Deletes the workflow definition link with the primary key from the database.static void
deleteWorkflowDefinitionLink
(long companyId, long groupId, String className, long classPK, long typePK) static WorkflowDefinitionLink
deleteWorkflowDefinitionLink
(WorkflowDefinitionLink workflowDefinitionLink) Deletes the workflow definition link from the database.static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static 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 WorkflowDefinitionLink
fetchDefaultWorkflowDefinitionLink
(long companyId, String className, long classPK, long typePK) static WorkflowDefinitionLink
fetchWorkflowDefinitionLink
(long workflowDefinitionLinkId) static WorkflowDefinitionLink
fetchWorkflowDefinitionLink
(long companyId, long groupId, String className, long classPK, long typePK) static WorkflowDefinitionLink
fetchWorkflowDefinitionLink
(long companyId, long groupId, String className, long classPK, long typePK, boolean strict) static WorkflowDefinitionLink
fetchWorkflowDefinitionLinkByExternalReferenceCode
(String externalReferenceCode, long groupId) static WorkflowDefinitionLink
fetchWorkflowDefinitionLinkByUuidAndGroupId
(String uuid, long groupId) Returns the workflow definition link matching the UUID and group.static List<WorkflowDefinitionLink>
fetchWorkflowDefinitionLinks
(long companyId, long groupId, String className, long classPK) static ActionableDynamicQuery
static WorkflowDefinitionLink
getDefaultWorkflowDefinitionLink
(long companyId, String className, long classPK, long typePK) static ExportActionableDynamicQuery
getExportActionableDynamicQuery
(PortletDataContext portletDataContext) static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static WorkflowDefinitionLink
getWorkflowDefinitionLink
(long workflowDefinitionLinkId) Returns the workflow definition link with the primary key.static WorkflowDefinitionLink
getWorkflowDefinitionLink
(long companyId, long groupId, String className, long classPK, long typePK) static WorkflowDefinitionLink
getWorkflowDefinitionLink
(long companyId, long groupId, String className, long classPK, long typePK, boolean strict) static WorkflowDefinitionLink
getWorkflowDefinitionLinkByExternalReferenceCode
(String externalReferenceCode, long groupId) static WorkflowDefinitionLink
getWorkflowDefinitionLinkByUuidAndGroupId
(String uuid, long groupId) Returns the workflow definition link matching the UUID and group.static List<WorkflowDefinitionLink>
getWorkflowDefinitionLinks
(int start, int end) Returns a range of all the workflow definition links.static List<WorkflowDefinitionLink>
getWorkflowDefinitionLinks
(long companyId, long groupId, long classPK) static List<WorkflowDefinitionLink>
getWorkflowDefinitionLinks
(long companyId, long groupId, String className, long classPK) static List<WorkflowDefinitionLink>
getWorkflowDefinitionLinks
(long companyId, String workflowDefinitionName, int workflowDefinitionVersion) static List<WorkflowDefinitionLink>
getWorkflowDefinitionLinksByUuidAndCompanyId
(String uuid, long companyId) Returns all the workflow definition links matching the UUID and company.static List<WorkflowDefinitionLink>
getWorkflowDefinitionLinksByUuidAndCompanyId
(String uuid, long companyId, int start, int end, OrderByComparator<WorkflowDefinitionLink> orderByComparator) Returns a range of workflow definition links matching the UUID and company.static int
Returns the number of workflow definition links.static int
getWorkflowDefinitionLinksCount
(long companyId, long groupId, String className) static int
getWorkflowDefinitionLinksCount
(long companyId, String workflowDefinitionName, int workflowDefinitionVersion) static boolean
hasWorkflowDefinitionLink
(long companyId, long groupId, String className) static boolean
hasWorkflowDefinitionLink
(long companyId, long groupId, String className, long classPK) static boolean
hasWorkflowDefinitionLink
(long companyId, long groupId, String className, long classPK, long typePK) static void
static void
updateWorkflowDefinitionLink
(long userId, long companyId, long groupId, String className, long classPK, long typePK, String workflowDefinition) static WorkflowDefinitionLink
updateWorkflowDefinitionLink
(long userId, long companyId, long groupId, String className, long classPK, long typePK, String workflowDefinitionName, int workflowDefinitionVersion) static WorkflowDefinitionLink
updateWorkflowDefinitionLink
(WorkflowDefinitionLink workflowDefinitionLink) Updates the workflow definition link in the database or adds it if it does not yet exist.static WorkflowDefinitionLink
updateWorkflowDefinitionLink
(String externalReferenceCode, long userId, long companyId, long groupId, String className, long classPK, long typePK, String workflowDefinitionName, int workflowDefinitionVersion) static void
updateWorkflowDefinitionLinks
(long userId, long companyId, long groupId, String className, long classPK, List<ObjectValuePair<Long, String>> workflowDefinitionOVPs)
-
Constructor Details
-
WorkflowDefinitionLinkLocalServiceUtil
public WorkflowDefinitionLinkLocalServiceUtil()
-
-
Method Details
-
addWorkflowDefinitionLink
public static WorkflowDefinitionLink addWorkflowDefinitionLink(long userId, long companyId, long groupId, String className, long classPK, long typePK, String workflowDefinitionName, int workflowDefinitionVersion) throws PortalException - Throws:
PortalException
-
addWorkflowDefinitionLink
public static WorkflowDefinitionLink addWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink) Adds the workflow definition link to the database. Also notifies the appropriate model listeners.Important: Inspect WorkflowDefinitionLinkLocalServiceImpl 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:
workflowDefinitionLink
- the workflow definition link- Returns:
- the workflow definition link that was added
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
createWorkflowDefinitionLink
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
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deleteWorkflowDefinitionLink
public static WorkflowDefinitionLink deleteWorkflowDefinitionLink(long workflowDefinitionLinkId) throws PortalException Deletes the workflow definition link with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect WorkflowDefinitionLinkLocalServiceImpl 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:
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
public static void deleteWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK, long typePK) -
deleteWorkflowDefinitionLink
public static WorkflowDefinitionLink deleteWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink) Deletes the workflow definition link from the database. Also notifies the appropriate model listeners.Important: Inspect WorkflowDefinitionLinkLocalServiceImpl 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:
workflowDefinitionLink
- the workflow definition link- Returns:
- the workflow definition link that was removed
-
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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.WorkflowDefinitionLinkModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.WorkflowDefinitionLinkModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDefaultWorkflowDefinitionLink
public static WorkflowDefinitionLink fetchDefaultWorkflowDefinitionLink(long companyId, String className, long classPK, long typePK) -
fetchWorkflowDefinitionLink
-
fetchWorkflowDefinitionLink
public static WorkflowDefinitionLink fetchWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK, long typePK) -
fetchWorkflowDefinitionLink
public static WorkflowDefinitionLink fetchWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK, long typePK, boolean strict) -
fetchWorkflowDefinitionLinkByExternalReferenceCode
public static WorkflowDefinitionLink fetchWorkflowDefinitionLinkByExternalReferenceCode(String externalReferenceCode, long groupId) -
fetchWorkflowDefinitionLinkByUuidAndGroupId
public static WorkflowDefinitionLink fetchWorkflowDefinitionLinkByUuidAndGroupId(String uuid, long groupId) Returns the workflow definition link matching the UUID and group.- Parameters:
uuid
- the workflow definition link's UUIDgroupId
- the primary key of the group- Returns:
- the matching workflow definition link, or
null
if a matching workflow definition link could not be found
-
fetchWorkflowDefinitionLinks
public static List<WorkflowDefinitionLink> fetchWorkflowDefinitionLinks(long companyId, long groupId, String className, long classPK) -
getActionableDynamicQuery
-
getDefaultWorkflowDefinitionLink
public static WorkflowDefinitionLink getDefaultWorkflowDefinitionLink(long companyId, String className, long classPK, long typePK) throws PortalException - Throws:
PortalException
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getWorkflowDefinitionLink
public static 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
public static WorkflowDefinitionLink getWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK, long typePK) throws PortalException - Throws:
PortalException
-
getWorkflowDefinitionLink
public static WorkflowDefinitionLink getWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK, long typePK, boolean strict) throws PortalException - Throws:
PortalException
-
getWorkflowDefinitionLinkByExternalReferenceCode
public static WorkflowDefinitionLink getWorkflowDefinitionLinkByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getWorkflowDefinitionLinkByUuidAndGroupId
public static WorkflowDefinitionLink getWorkflowDefinitionLinkByUuidAndGroupId(String uuid, long groupId) throws PortalException Returns the workflow definition link matching the UUID and group.- Parameters:
uuid
- the workflow definition link's UUIDgroupId
- the primary key of the group- Returns:
- the matching workflow definition link
- Throws:
PortalException
- if a matching workflow definition link could not be found
-
getWorkflowDefinitionLinks
Returns a range of all the workflow definition links.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.WorkflowDefinitionLinkModelImpl
.- Parameters:
start
- the lower bound of the range of workflow definition linksend
- the upper bound of the range of workflow definition links (not inclusive)- Returns:
- the range of workflow definition links
-
getWorkflowDefinitionLinks
public static List<WorkflowDefinitionLink> getWorkflowDefinitionLinks(long companyId, long groupId, long classPK) throws PortalException - Throws:
PortalException
-
getWorkflowDefinitionLinks
public static List<WorkflowDefinitionLink> getWorkflowDefinitionLinks(long companyId, long groupId, String className, long classPK) throws PortalException - Throws:
PortalException
-
getWorkflowDefinitionLinks
public static List<WorkflowDefinitionLink> getWorkflowDefinitionLinks(long companyId, String workflowDefinitionName, int workflowDefinitionVersion) throws PortalException - Throws:
PortalException
-
getWorkflowDefinitionLinksByUuidAndCompanyId
public static List<WorkflowDefinitionLink> getWorkflowDefinitionLinksByUuidAndCompanyId(String uuid, long companyId) Returns all the workflow definition links matching the UUID and company.- Parameters:
uuid
- the UUID of the workflow definition linkscompanyId
- the primary key of the company- Returns:
- the matching workflow definition links, or an empty list if no matches were found
-
getWorkflowDefinitionLinksByUuidAndCompanyId
public static List<WorkflowDefinitionLink> getWorkflowDefinitionLinksByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<WorkflowDefinitionLink> orderByComparator) Returns a range of workflow definition links matching the UUID and company.- Parameters:
uuid
- the UUID of the workflow definition linkscompanyId
- the primary key of the companystart
- the lower bound of the range of workflow definition linksend
- the upper bound of the range of workflow definition links (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching workflow definition links, or an empty list if no matches were found
-
getWorkflowDefinitionLinksCount
public static int getWorkflowDefinitionLinksCount()Returns the number of workflow definition links.- Returns:
- the number of workflow definition links
-
getWorkflowDefinitionLinksCount
-
getWorkflowDefinitionLinksCount
public static int getWorkflowDefinitionLinksCount(long companyId, String workflowDefinitionName, int workflowDefinitionVersion) -
hasWorkflowDefinitionLink
-
hasWorkflowDefinitionLink
public static boolean hasWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK) -
hasWorkflowDefinitionLink
public static boolean hasWorkflowDefinitionLink(long companyId, long groupId, String className, long classPK, long typePK) -
updateWorkflowDefinitionLink
public static void updateWorkflowDefinitionLink(long userId, long companyId, long groupId, String className, long classPK, long typePK, String workflowDefinition) throws PortalException - Throws:
PortalException
-
updateWorkflowDefinitionLink
public static WorkflowDefinitionLink updateWorkflowDefinitionLink(long userId, long companyId, long groupId, String className, long classPK, long typePK, String workflowDefinitionName, int workflowDefinitionVersion) throws PortalException - Throws:
PortalException
-
updateWorkflowDefinitionLink
public static WorkflowDefinitionLink updateWorkflowDefinitionLink(String externalReferenceCode, long userId, long companyId, long groupId, String className, long classPK, long typePK, String workflowDefinitionName, int workflowDefinitionVersion) throws PortalException - Throws:
PortalException
-
updateWorkflowDefinitionLink
public static 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.Important: Inspect WorkflowDefinitionLinkLocalServiceImpl 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:
workflowDefinitionLink
- the workflow definition link- Returns:
- the workflow definition link that was updated
-
updateWorkflowDefinitionLinks
public static void updateWorkflowDefinitionLinks(long userId, long companyId, long groupId, String className, long classPK, List<ObjectValuePair<Long, String>> workflowDefinitionOVPs) throws PortalException- Throws:
PortalException
-
getService
-
setService
-