Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Class WorkflowInstanceLinkLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.WorkflowInstanceLinkLocalServiceUtil

public class WorkflowInstanceLinkLocalServiceUtil
extends Object

The utility for the workflow instance link local service. This utility wraps WorkflowInstanceLinkLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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:
WorkflowInstanceLinkLocalService, WorkflowInstanceLinkLocalServiceBaseImpl, WorkflowInstanceLinkLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
WorkflowInstanceLinkLocalServiceUtil()
           
 
Method Summary
static WorkflowInstanceLink addWorkflowInstanceLink(long userId, long companyId, long groupId, String className, long classPK, long workflowInstanceId)
           
static WorkflowInstanceLink addWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
          Adds the workflow instance link to the database.
static WorkflowInstanceLink createWorkflowInstanceLink(long workflowInstanceLinkId)
          Creates a new workflow instance link with the primary key.
static WorkflowInstanceLink deleteWorkflowInstanceLink(long workflowInstanceLinkId)
          Deletes the workflow instance link with the primary key from the database.
static void deleteWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
           
static WorkflowInstanceLink deleteWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
          Deletes the workflow instance link from the database.
static void deleteWorkflowInstanceLinks(long companyId, long groupId, String className, long classPK)
           
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static WorkflowInstanceLink fetchWorkflowInstanceLink(long workflowInstanceLinkId)
           
static WorkflowInstanceLink fetchWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static WorkflowInstanceLinkLocalService getService()
           
static String getState(long companyId, long groupId, String className, long classPK)
           
static WorkflowInstanceLink getWorkflowInstanceLink(long workflowInstanceLinkId)
          Returns the workflow instance link with the primary key.
static WorkflowInstanceLink getWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
           
static List<WorkflowInstanceLink> getWorkflowInstanceLinks(int start, int end)
          Returns a range of all the workflow instance links.
static List<WorkflowInstanceLink> getWorkflowInstanceLinks(long companyId, long groupId, String className, long classPK)
           
static int getWorkflowInstanceLinksCount()
          Returns the number of workflow instance links.
static boolean hasWorkflowInstanceLink(long companyId, long groupId, String className, long classPK)
           
static boolean isEnded(long companyId, long groupId, String className, long classPK)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(WorkflowInstanceLinkLocalService service)
          Deprecated.  
static void startWorkflowInstance(long companyId, long groupId, long userId, String className, long classPK, Map<String,Serializable> workflowContext)
           
static void updateClassPK(long companyId, long groupId, String className, long oldClassPK, long newClassPK)
           
static WorkflowInstanceLink updateWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink)
          Updates the workflow instance link in the database or adds it if it does not yet exist.
static WorkflowInstanceLink updateWorkflowInstanceLink(WorkflowInstanceLink workflowInstanceLink, boolean merge)
          Updates the workflow instance link in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WorkflowInstanceLinkLocalServiceUtil

public WorkflowInstanceLinkLocalServiceUtil()
Method Detail

addWorkflowInstanceLink

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

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

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

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

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

public static WorkflowInstanceLink fetchWorkflowInstanceLink(long workflowInstanceLinkId)
                                                      throws SystemException
Throws:
SystemException

getWorkflowInstanceLink

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

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getWorkflowInstanceLinks

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

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

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

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

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addWorkflowInstanceLink

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

deleteWorkflowInstanceLink

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

deleteWorkflowInstanceLinks

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

fetchWorkflowInstanceLink

public static WorkflowInstanceLink fetchWorkflowInstanceLink(long companyId,
                                                             long groupId,
                                                             String className,
                                                             long classPK)
                                                      throws SystemException
Throws:
SystemException

getState

public static String getState(long companyId,
                              long groupId,
                              String className,
                              long classPK)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

getWorkflowInstanceLink

public static WorkflowInstanceLink getWorkflowInstanceLink(long companyId,
                                                           long groupId,
                                                           String className,
                                                           long classPK)
                                                    throws PortalException,
                                                           SystemException
Throws:
PortalException
SystemException

getWorkflowInstanceLinks

public static List<WorkflowInstanceLink> getWorkflowInstanceLinks(long companyId,
                                                                  long groupId,
                                                                  String className,
                                                                  long classPK)
                                                           throws SystemException
Throws:
SystemException

hasWorkflowInstanceLink

public static boolean hasWorkflowInstanceLink(long companyId,
                                              long groupId,
                                              String className,
                                              long classPK)
                                       throws SystemException
Throws:
SystemException

isEnded

public static boolean isEnded(long companyId,
                              long groupId,
                              String className,
                              long classPK)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

startWorkflowInstance

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

updateClassPK

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

getService

public static WorkflowInstanceLinkLocalService getService()

setService

public void setService(WorkflowInstanceLinkLocalService service)
Deprecated. 


Liferay 6.1.2-ce-ga3