Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Interface WorkflowDefinitionLinkLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
WorkflowDefinitionLinkLocalServiceBaseImpl, WorkflowDefinitionLinkLocalServiceImpl, WorkflowDefinitionLinkLocalServiceWrapper

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

The interface for the workflow definition 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:
WorkflowDefinitionLinkLocalServiceUtil, WorkflowDefinitionLinkLocalServiceBaseImpl, WorkflowDefinitionLinkLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 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.
 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()
           
 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.
 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)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 WorkflowDefinitionLink getDefaultWorkflowDefinitionLink(long companyId, String className, long classPK, long typePK)
           
 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, 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 setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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.
 WorkflowDefinitionLink updateWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink, boolean merge)
          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>> workflowDefinitions)
           
 

Method Detail

addWorkflowDefinitionLink

WorkflowDefinitionLink addWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink)
                                                 throws SystemException
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
Throws:
SystemException - if a system exception occurred

createWorkflowDefinitionLink

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

deleteWorkflowDefinitionLink

WorkflowDefinitionLink deleteWorkflowDefinitionLink(long workflowDefinitionLinkId)
                                                    throws PortalException,
                                                           SystemException
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
SystemException - if a system exception occurred

deleteWorkflowDefinitionLink

WorkflowDefinitionLink deleteWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink)
                                                    throws SystemException
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
Throws:
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

fetchWorkflowDefinitionLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowDefinitionLink fetchWorkflowDefinitionLink(long workflowDefinitionLinkId)
                                                   throws SystemException
Throws:
SystemException

getWorkflowDefinitionLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WorkflowDefinitionLink getWorkflowDefinitionLink(long workflowDefinitionLinkId)
                                                 throws PortalException,
                                                        SystemException
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
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

getWorkflowDefinitionLinks

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

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
Throws:
SystemException - if a system exception occurred

getWorkflowDefinitionLinksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWorkflowDefinitionLinksCount()
                                    throws SystemException
Returns the number of workflow definition links.

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

updateWorkflowDefinitionLink

WorkflowDefinitionLink updateWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink)
                                                    throws SystemException
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
Throws:
SystemException - if a system exception occurred

updateWorkflowDefinitionLink

WorkflowDefinitionLink updateWorkflowDefinitionLink(WorkflowDefinitionLink workflowDefinitionLink,
                                                    boolean merge)
                                                    throws SystemException
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
merge - whether to merge the workflow definition 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 definition 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

addWorkflowDefinitionLink

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

deleteWorkflowDefinitionLink

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

fetchDefaultWorkflowDefinitionLink

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

fetchWorkflowDefinitionLink

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

fetchWorkflowDefinitionLink

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

getDefaultWorkflowDefinitionLink

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

getWorkflowDefinitionLink

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

getWorkflowDefinitionLink

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

getWorkflowDefinitionLinksCount

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

hasWorkflowDefinitionLink

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

hasWorkflowDefinitionLink

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

hasWorkflowDefinitionLink

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

updateWorkflowDefinitionLink

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

updateWorkflowDefinitionLink

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

updateWorkflowDefinitionLinks

void updateWorkflowDefinitionLinks(long userId,
                                   long companyId,
                                   long groupId,
                                   String className,
                                   long classPK,
                                   List<ObjectValuePair<Long,String>> workflowDefinitions)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

Liferay 6.1.2-ce-ga3