com.tibco.bpm.service.connector

Class BusinessService

java.lang.Object

com.tibco.bpm.service.connector.BusinessService

All Implemented Interfaces:

BusinessService

public class BusinessService
extends java.lang.Object
implements BusinessService

Provides access to the BusinessService interfaces.

©2011 TIBCO Software Inc.

Since:

1.2

Method Summary

Modifier and Type	Method and Description
com.tibco.n2.busserv.api.business.CancelBusinessServiceResponseDocument.CancelBusinessServiceResponse	cancelBusinessService(java.lang.String processInstanceId) Cancels BusinessService.
com.tibco.n2.busserv.api.business.InjectBusinessServiceEventResponseDocument.InjectBusinessServiceEventResponse	injectBusinessServiceEvent(com.tibco.n2.pfe.api.common.EventDefinitionType eventDefinition, com.tibco.n2.common.datafeed.DataPayload formalParams, com.tibco.n2.common.datafeed.PayloadModeType.Enum responsePayloadMode) Injects BusinessServiceEvent.
com.tibco.n2.busserv.api.business.ListBusinessServicesResponseDocument.ListBusinessServicesResponse	listBusinessServices(java.lang.Long startPosition, java.lang.Long numberOfItems, java.lang.Boolean getTotalCount, com.tibco.n2.pfe.api.common.OrderFilterCriteria orderFilterCriteria, java.lang.Boolean includeFormalParameters, java.lang.String channelId) Lists BusinessServices.
com.tibco.n2.busserv.api.business.ListCaseActionResponseDocument.ListCaseActionResponse	listCaseAction(java.lang.Long startPosition, java.lang.Long numberOfItems, java.lang.Boolean getTotalCount, com.tibco.n2.pfe.api.common.OrderFilterCriteria orderFilterCriteria, java.lang.Boolean includeFormalParameters, java.lang.String channelId, java.lang.String caseReference) Lists CaseAction
com.tibco.n2.busserv.api.business.ListCategoriesResponseDocument.ListCategoriesResponse	listCategories(java.lang.Long startPosition, java.lang.Long numberOfItems, java.lang.Boolean getTotalCount, com.tibco.n2.pfe.api.common.OrderFilterCriteria orderFilterCriteria, java.lang.Boolean includeFormalParameters, java.lang.String channelId) Lists Categories.
com.tibco.n2.busserv.api.business.QueryBusinessServicesResponseDocument.QueryBusinessServicesResponse	queryBusinessServices(java.lang.String category, java.lang.String channelId, boolean includeFormalParameters) Queries BusinessServices.
com.tibco.n2.busserv.api.business.QueryCategoriesResponseDocument.QueryCategoriesResponse	queryCategories(java.lang.String category, java.lang.String channelId, boolean includeFormalParameters) Queries Categories.
com.tibco.n2.busserv.api.business.StartBusinessServiceResponseDocument.StartBusinessServiceResponse	startBusinessService(com.tibco.n2.pfe.api.common.BusinessServiceTemplate businessServiceDefinition, com.tibco.n2.common.datafeed.DataPayload formalParams, com.tibco.n2.common.datafeed.PayloadModeType.Enum responsePayloadMode, java.lang.Long cacheTimeout) Starts BusinessService.
com.tibco.n2.busserv.api.business.UpdateBusinessServiceResponseDocument.UpdateBusinessServiceResponse	updateBusinessService(com.tibco.n2.pfe.api.common.RequestContext context, com.tibco.n2.common.datafeed.DataPayload pageFields, com.tibco.n2.common.datafeed.PayloadModeType.Enum payloadMode) Updates BusinessService.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

listCategories

public com.tibco.n2.busserv.api.business.ListCategoriesResponseDocument.ListCategoriesResponse listCategories(java.lang.Long startPosition,
                                                                                                              java.lang.Long numberOfItems,
                                                                                                              java.lang.Boolean getTotalCount,
                                                                                                              com.tibco.n2.pfe.api.common.OrderFilterCriteria orderFilterCriteria,
                                                                                                              java.lang.Boolean includeFormalParameters,
                                                                                                              java.lang.String channelId)
                                                                                                       throws com.tibco.n2.busserv.services.InternalServiceFault,
                                                                                                              com.tibco.n2.busserv.services.InvalidArgumentFault,
                                                                                                              com.tibco.n2.busserv.services.PageFlowExecutionFault

Description copied from interface: BusinessService

Lists Categories.

Specified by:

listCategories in interface BusinessService

Returns:

Throws:

com.tibco.n2.busserv.services.InternalServiceFault

com.tibco.n2.busserv.services.InvalidArgumentFault

com.tibco.n2.busserv.services.PageFlowExecutionFault

queryCategories

public com.tibco.n2.busserv.api.business.QueryCategoriesResponseDocument.QueryCategoriesResponse queryCategories(java.lang.String category,
                                                                                                                 java.lang.String channelId,
                                                                                                                 boolean includeFormalParameters)
                                                                                                          throws com.tibco.n2.busserv.services.InternalServiceFault,
                                                                                                                 com.tibco.n2.busserv.services.InvalidArgumentFault,
                                                                                                                 com.tibco.n2.busserv.services.PageFlowExecutionFault

Description copied from interface: BusinessService

Queries Categories.

Specified by:

queryCategories in interface BusinessService

Returns:

Throws:

com.tibco.n2.busserv.services.InternalServiceFault

com.tibco.n2.busserv.services.InvalidArgumentFault

com.tibco.n2.busserv.services.PageFlowExecutionFault

listBusinessServices

public com.tibco.n2.busserv.api.business.ListBusinessServicesResponseDocument.ListBusinessServicesResponse listBusinessServices(java.lang.Long startPosition,
                                                                                                                                java.lang.Long numberOfItems,
                                                                                                                                java.lang.Boolean getTotalCount,
                                                                                                                                com.tibco.n2.pfe.api.common.OrderFilterCriteria orderFilterCriteria,
                                                                                                                                java.lang.Boolean includeFormalParameters,
                                                                                                                                java.lang.String channelId)
                                                                                                                         throws com.tibco.n2.busserv.services.InternalServiceFault,
                                                                                                                                com.tibco.n2.busserv.services.InvalidArgumentFault,
                                                                                                                                com.tibco.n2.busserv.services.PageFlowExecutionFault

Description copied from interface: BusinessService

Lists BusinessServices.

Specified by:

listBusinessServices in interface BusinessService

Returns:

Throws:

com.tibco.n2.busserv.services.InternalServiceFault

com.tibco.n2.busserv.services.InvalidArgumentFault

com.tibco.n2.busserv.services.PageFlowExecutionFault

queryBusinessServices

public com.tibco.n2.busserv.api.business.QueryBusinessServicesResponseDocument.QueryBusinessServicesResponse queryBusinessServices(java.lang.String category,
                                                                                                                                   java.lang.String channelId,
                                                                                                                                   boolean includeFormalParameters)
                                                                                                                            throws com.tibco.n2.busserv.services.InternalServiceFault,
                                                                                                                                   com.tibco.n2.busserv.services.InvalidArgumentFault,
                                                                                                                                   com.tibco.n2.busserv.services.PageFlowExecutionFault

Description copied from interface: BusinessService

Queries BusinessServices.

Specified by:

queryBusinessServices in interface BusinessService

Returns:

Throws:

com.tibco.n2.busserv.services.InternalServiceFault

com.tibco.n2.busserv.services.InvalidArgumentFault

com.tibco.n2.busserv.services.PageFlowExecutionFault

startBusinessService

public com.tibco.n2.busserv.api.business.StartBusinessServiceResponseDocument.StartBusinessServiceResponse startBusinessService(com.tibco.n2.pfe.api.common.BusinessServiceTemplate businessServiceDefinition,
                                                                                                                                com.tibco.n2.common.datafeed.DataPayload formalParams,
                                                                                                                                com.tibco.n2.common.datafeed.PayloadModeType.Enum responsePayloadMode,
                                                                                                                                java.lang.Long cacheTimeout)
                                                                                                                         throws com.tibco.n2.busserv.services.InternalServiceFault,
                                                                                                                                com.tibco.n2.busserv.services.InvalidArgumentFault,
                                                                                                                                com.tibco.n2.busserv.services.PageFlowExecutionFault

Description copied from interface: BusinessService

Starts BusinessService.

Specified by:

startBusinessService in interface BusinessService

Returns:

Throws:

com.tibco.n2.busserv.services.InternalServiceFault

com.tibco.n2.busserv.services.InvalidArgumentFault

com.tibco.n2.busserv.services.PageFlowExecutionFault

updateBusinessService

public com.tibco.n2.busserv.api.business.UpdateBusinessServiceResponseDocument.UpdateBusinessServiceResponse updateBusinessService(com.tibco.n2.pfe.api.common.RequestContext context,
                                                                                                                                   com.tibco.n2.common.datafeed.DataPayload pageFields,
                                                                                                                                   com.tibco.n2.common.datafeed.PayloadModeType.Enum payloadMode)
                                                                                                                            throws com.tibco.n2.busserv.services.InternalServiceFault,
                                                                                                                                   com.tibco.n2.busserv.services.InvalidArgumentFault,
                                                                                                                                   com.tibco.n2.busserv.services.PageFlowExecutionFault

Description copied from interface: BusinessService

Updates BusinessService.

Specified by:

updateBusinessService in interface BusinessService

Returns:

Throws:

com.tibco.n2.busserv.services.InternalServiceFault

com.tibco.n2.busserv.services.InvalidArgumentFault

com.tibco.n2.busserv.services.PageFlowExecutionFault

injectBusinessServiceEvent

public com.tibco.n2.busserv.api.business.InjectBusinessServiceEventResponseDocument.InjectBusinessServiceEventResponse injectBusinessServiceEvent(com.tibco.n2.pfe.api.common.EventDefinitionType eventDefinition,
                                                                                                                                                  com.tibco.n2.common.datafeed.DataPayload formalParams,
                                                                                                                                                  com.tibco.n2.common.datafeed.PayloadModeType.Enum responsePayloadMode)
                                                                                                                                           throws com.tibco.n2.busserv.services.InternalServiceFault,
                                                                                                                                                  com.tibco.n2.busserv.services.InvalidArgumentFault,
                                                                                                                                                  com.tibco.n2.busserv.services.PageFlowExecutionFault

Description copied from interface: BusinessService

Injects BusinessServiceEvent.

Specified by:

injectBusinessServiceEvent in interface BusinessService

Returns:

Throws:

com.tibco.n2.busserv.services.InternalServiceFault

com.tibco.n2.busserv.services.InvalidArgumentFault

com.tibco.n2.busserv.services.PageFlowExecutionFault

cancelBusinessService

public com.tibco.n2.busserv.api.business.CancelBusinessServiceResponseDocument.CancelBusinessServiceResponse cancelBusinessService(java.lang.String processInstanceId)
                                                                                                                            throws com.tibco.n2.busserv.services.InternalServiceFault,
                                                                                                                                   com.tibco.n2.busserv.services.InvalidArgumentFault,
                                                                                                                                   com.tibco.n2.busserv.services.PageFlowExecutionFault

Description copied from interface: BusinessService

Cancels BusinessService.

Specified by:

cancelBusinessService in interface BusinessService

Returns:

Throws:

com.tibco.n2.busserv.services.InternalServiceFault

com.tibco.n2.busserv.services.InvalidArgumentFault

com.tibco.n2.busserv.services.PageFlowExecutionFault

listCaseAction

public com.tibco.n2.busserv.api.business.ListCaseActionResponseDocument.ListCaseActionResponse listCaseAction(java.lang.Long startPosition,
                                                                                                              java.lang.Long numberOfItems,
                                                                                                              java.lang.Boolean getTotalCount,
                                                                                                              com.tibco.n2.pfe.api.common.OrderFilterCriteria orderFilterCriteria,
                                                                                                              java.lang.Boolean includeFormalParameters,
                                                                                                              java.lang.String channelId,
                                                                                                              java.lang.String caseReference)
                                                                                                       throws com.tibco.n2.busserv.services.InternalServiceFault,
                                                                                                              com.tibco.n2.busserv.services.InvalidArgumentFault

Description copied from interface: BusinessService

Lists CaseAction

Specified by:

listCaseAction in interface BusinessService

Returns:

Throws:

com.tibco.n2.busserv.services.InternalServiceFault

com.tibco.n2.busserv.services.InvalidArgumentFault