Liferay 6.0.5

com.liferay.portal.service
Interface WorkflowInstanceLinkLocalService

All Known Implementing Classes:
WorkflowInstanceLinkLocalServiceBaseImpl, WorkflowInstanceLinkLocalServiceImpl, WorkflowInstanceLinkLocalServiceWrapper

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

The interface for the workflow instance link local service.

Never modify or reference this interface directly. Always use WorkflowInstanceLinkLocalServiceUtil to access the workflow instance link local service. Add custom service methods to WorkflowInstanceLinkLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. 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.

See Also:
WorkflowInstanceLinkLocalServiceUtil, WorkflowInstanceLinkLocalServiceBaseImpl, WorkflowInstanceLinkLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 WorkflowInstanceLink addWorkflowInstanceLink(long userId, long companyId, long groupId, 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.
 void deleteWorkflowInstanceLink(long workflowInstanceLinkId)
          Deletes the workflow instance link with the primary key from the database.
 void deleteWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
           
 void deleteWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
          Deletes the workflow instance link from the database.
 void deleteWorkflowInstanceLinks(long companyId, long groupId, String className, long classPK)
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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)
          Counts the number of rows that match the dynamic query.
 String getState(long companyId, long groupId, String className, long classPK)
           
 WorkflowInstanceLink getWorkflowInstanceLink(long workflowInstanceLinkId)
          Gets the workflow instance link with the primary key.
 WorkflowInstanceLink getWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
           
 List<WorkflowInstanceLink> getWorkflowInstanceLinks(int start, int end)
          Gets a range of all the workflow instance links.
 List<WorkflowInstanceLink> getWorkflowInstanceLinks(long companyId, long groupId, String className, long classPK)
           
 int getWorkflowInstanceLinksCount()
          Gets the number of workflow instance links.
 boolean hasWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
           
 boolean isEnded(long companyId, long groupId, String className, long classPK)
           
 void startWorkflowInstance(long companyId, long groupId, long userId, String className, long classPK, Map<String,Serializable> workflowContext)
           
 void updateClassPK(long companyId, long groupId, String className, long oldClassPK, long newClassPK)
           
 WorkflowInstanceLink updateWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
          Updates the workflow instance link in the database.
 WorkflowInstanceLink updateWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink, boolean merge)
          Updates the workflow instance link in the database.
 

Method Detail

addWorkflowInstanceLink

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 to add
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

void 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 to delete
Throws:
PortalException - if a workflow instance link with the primary key could not be found
SystemException - if a system exception occurred

deleteWorkflowInstanceLink

void deleteWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
                                throws SystemException
Deletes the workflow instance link from the database. Also notifies the appropriate model listeners.

Parameters:
workflowInstanceLink - the workflow instance link to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getWorkflowInstanceLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowInstanceLink getWorkflowInstanceLink(long workflowInstanceLinkId)
                                             throws PortalException,
                                                    SystemException
Gets the workflow instance link with the primary key.

Parameters:
workflowInstanceLinkId - the primary key of the workflow instance link to get
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

getWorkflowInstanceLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WorkflowInstanceLink> getWorkflowInstanceLinks(int start,
                                                                                             int end)
                                                    throws SystemException
Gets 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.

Parameters:
start - the lower bound of the range of workflow instance links to return
end - the upper bound of the range of workflow instance links to return (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
Gets the number of workflow instance links.

Returns:
the number of workflow instance links
Throws:
SystemException - if a system exception occurred

updateWorkflowInstanceLink

WorkflowInstanceLink updateWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
                                                throws SystemException
Updates the workflow instance link in the database. Also notifies the appropriate model listeners.

Parameters:
workflowInstanceLink - the workflow instance link to update
Returns:
the workflow instance link that was updated
Throws:
SystemException - if a system exception occurred

updateWorkflowInstanceLink

WorkflowInstanceLink updateWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink,
                                                boolean merge)
                                                throws SystemException
Updates the workflow instance link in the database. Also notifies the appropriate model listeners.

Parameters:
workflowInstanceLink - the workflow instance link to update
merge - whether to merge the workflow instance link with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the workflow instance link that was updated
Throws:
SystemException - if a system exception occurred

addWorkflowInstanceLink

WorkflowInstanceLink addWorkflowInstanceLink(long userId,
                                             long companyId,
                                             long groupId,
                                             String className,
                                             long classPK,
                                             long workflowInstanceId)
                                             throws PortalException,
                                                    SystemException
Throws:
PortalException
SystemException

deleteWorkflowInstanceLink

void deleteWorkflowInstanceLink(long companyId,
                                long groupId,
                                String className,
                                long classPK)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

deleteWorkflowInstanceLinks

void deleteWorkflowInstanceLinks(long companyId,
                                 long groupId,
                                 String className,
                                 long classPK)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

getState

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

getWorkflowInstanceLink

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

getWorkflowInstanceLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WorkflowInstanceLink> getWorkflowInstanceLinks(long companyId,
                                                                                             long groupId,
                                                                                             String className,
                                                                                             long classPK)
                                                    throws SystemException
Throws:
SystemException

hasWorkflowInstanceLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasWorkflowInstanceLink(long companyId,
                                                                         long groupId,
                                                                         String className,
                                                                         long classPK)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

isEnded

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

startWorkflowInstance

void startWorkflowInstance(long companyId,
                           long groupId,
                           long userId,
                           String className,
                           long classPK,
                           Map<String,Serializable> workflowContext)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

updateClassPK

void updateClassPK(long companyId,
                   long groupId,
                   String className,
                   long oldClassPK,
                   long newClassPK)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

Liferay 6.0.5