Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Interface WorkflowInstanceLinkLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
WorkflowInstanceLinkLocalServiceWrapper

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

The interface for the workflow instance link local service.

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

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.
 WorkflowInstanceLink 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)
           
 WorkflowInstanceLink deleteWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
          Deletes the workflow instance link from the database.
 void deleteWorkflowInstanceLinks(long companyId, long groupId, String className, long classPK)
           
 DynamicQuery dynamicQuery()
           
 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)
          Returns the number of rows that match the dynamic query.
 WorkflowInstanceLink fetchWorkflowInstanceLink(long workflowInstanceLinkId)
           
 WorkflowInstanceLink fetchWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 String getState(long companyId, long groupId, String className, long classPK)
           
 WorkflowInstanceLink getWorkflowInstanceLink(long workflowInstanceLinkId)
          Returns 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)
          Returns a range of all the workflow instance links.
 List<WorkflowInstanceLink> getWorkflowInstanceLinks(long companyId, long groupId, String className, long classPK)
           
 int getWorkflowInstanceLinksCount()
          Returns 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 setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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 or adds it if it does not yet exist.
 WorkflowInstanceLink updateWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink, boolean merge)
          Updates the workflow instance link in the database or adds it if it does not yet exist.
 

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

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

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

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

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

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

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(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getWorkflowInstanceLinks

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

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

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

updateWorkflowInstanceLink

WorkflowInstanceLink updateWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink,
                                                boolean merge)
                                                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
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

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(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,
                                             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

fetchWorkflowInstanceLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowInstanceLink fetchWorkflowInstanceLink(long companyId,
                                                                                        long groupId,
                                                                                        String className,
                                                                                        long classPK)
                                               throws SystemException
Throws:
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 SystemException
Throws:
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.1.2-ce-ga3