Interface WorkflowInstanceLinkLocalService
- All Superinterfaces:
BaseLocalService
,CTService<WorkflowInstanceLink>
,PersistedModelLocalService
- All Known Implementing Classes:
WorkflowInstanceLinkLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddWorkflowInstanceLink
(long userId, long companyId, long groupId, String className, long classPK, long workflowInstanceId) addWorkflowInstanceLink
(WorkflowInstanceLink workflowInstanceLink) Adds the workflow instance link to the database.createPersistedModel
(Serializable primaryKeyObj) createWorkflowInstanceLink
(long workflowInstanceLinkId) Creates a new workflow instance link with the primary key.deletePersistedModel
(PersistedModel persistedModel) deleteWorkflowInstanceLink
(long workflowInstanceLinkId) Deletes the workflow instance link with the primary key from the database.deleteWorkflowInstanceLink
(long companyId, long groupId, String className, long classPK) deleteWorkflowInstanceLink
(WorkflowInstanceLink workflowInstanceLink) Deletes the workflow instance link from the database.void
deleteWorkflowInstanceLinks
(long companyId, long groupId, String className, long classPK) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchWorkflowInstanceLink
(long workflowInstanceLinkId) fetchWorkflowInstanceLink
(long companyId, long groupId, String className, long classPK) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getWorkflowInstanceLink
(long workflowInstanceLinkId) Returns the workflow instance link with the primary key.getWorkflowInstanceLink
(long companyId, long groupId, String className, long classPK) getWorkflowInstanceLinks
(int start, int end) Returns a range of all the workflow instance links.getWorkflowInstanceLinks
(long companyId, long groupId, String className, long classPK) int
Returns the number of workflow instance links.boolean
hasWorkflowInstanceLink
(long companyId, long groupId, String className, long classPK) boolean
void
startWorkflowInstance
(long companyId, long groupId, long userId, String className, long classPK, Map<String, Serializable> workflowContext) void
startWorkflowInstance
(long companyId, long groupId, long userId, String className, long classPK, Map<String, Serializable> workflowContext, boolean waitForCompletion) void
updateClassPK
(long companyId, long groupId, String className, long oldClassPK, long newClassPK) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<WorkflowInstanceLink>, R, E> updateUnsafeFunction) updateWorkflowInstanceLink
(WorkflowInstanceLink workflowInstanceLink) Updates the workflow instance link in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addWorkflowInstanceLink
WorkflowInstanceLink addWorkflowInstanceLink(long userId, long companyId, long groupId, 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.Important: Inspect WorkflowInstanceLinkLocalServiceImpl 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:
workflowInstanceLink
- the workflow instance link- Returns:
- the workflow instance link that was added
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
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
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- 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.Important: Inspect WorkflowInstanceLinkLocalServiceImpl 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:
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, String className, long classPK) throws PortalException - Throws:
PortalException
-
deleteWorkflowInstanceLink
@Indexable(type=DELETE) @SystemEvent(type=1) WorkflowInstanceLink deleteWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink) throws PortalException Deletes the workflow instance link from the database. Also notifies the appropriate model listeners.Important: Inspect WorkflowInstanceLinkLocalServiceImpl 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:
workflowInstanceLink
- the workflow instance link- Returns:
- the workflow instance link that was removed
- Throws:
PortalException
-
deleteWorkflowInstanceLinks
void deleteWorkflowInstanceLinks(long companyId, long groupId, String className, long classPK) throws PortalException - Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
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
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.WorkflowInstanceLinkModelImpl
.- 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
@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
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.WorkflowInstanceLinkModelImpl
.- 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
@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 queryprojection
- 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, String className, long classPK) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
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 interfacePersistedModelLocalService
- Throws:
PortalException
-
getState
@Transactional(propagation=SUPPORTS, readOnly=true) String getState(long companyId, long groupId, 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, String className, long classPK) throws PortalException - Throws:
PortalException
-
getWorkflowInstanceLinks
@Transactional(propagation=SUPPORTS, readOnly=true) 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
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.WorkflowInstanceLinkModelImpl
.- Parameters:
start
- the lower bound of the range of workflow instance linksend
- 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) List<WorkflowInstanceLink> getWorkflowInstanceLinks(long companyId, long groupId, String className, long classPK) -
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, String className, long classPK) -
isEnded
@Transactional(propagation=SUPPORTS, readOnly=true) boolean isEnded(long companyId, long groupId, String className, long classPK) throws PortalException - Throws:
PortalException
-
startWorkflowInstance
void startWorkflowInstance(long companyId, long groupId, long userId, String className, long classPK, Map<String, Serializable> workflowContext) throws PortalException- Throws:
PortalException
-
startWorkflowInstance
void startWorkflowInstance(long companyId, long groupId, long userId, String className, long classPK, Map<String, Serializable> workflowContext, boolean waitForCompletion) throws PortalException- Throws:
PortalException
-
updateClassPK
void updateClassPK(long companyId, long groupId, 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.Important: Inspect WorkflowInstanceLinkLocalServiceImpl 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:
workflowInstanceLink
- the workflow instance link- Returns:
- the workflow instance link that was updated
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<WorkflowInstanceLink>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<WorkflowInstanceLink>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<WorkflowInstanceLink>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<WorkflowInstanceLink>
- Throws:
E extends Throwable
-