ProcessorService
Session Bean implementation class ProcessorWebService
Endpoint Metadata
- Namespace: http://opencase.extend.com/contentprocessor/webservices/processor
- Endpoint Name: ProcessorWebService
- Endpoint Address: http(s)://{VMS URL}/ContentProcessor/webservices/processor-service
The following methods are available on this endpoint:
Creates a new ProcessorAction entity based on the specified processor action model.
Input Parameters
name |
type |
description |
processorActionToCreate |
processorAction
|
The model of the processor action to create. |
Return Value
type |
description |
processorAction
|
The created ProcessorAction object with filled unique identifies like primary key and UUID. |
Faults
name |
description |
ProcessorWebServiceFault |
If the primary key or UUID or primary key of the specified processor action to create are notnull, if processConfiguration or name are not null. |
Creates a new ProcessorConfiguration entity based on the specified model processor configuration.
Input Parameters
name |
type |
description |
processorConfigurationToCreate |
processorConfiguration
|
The model of the processor configuration to create. |
Return Value
type |
description |
processorConfiguration
|
The created ProcessorConfiguration object with filled unique identifies like primary key and UUID. |
Faults
name |
description |
ProcessorWebServiceFault |
If the primary key or UUID of the specified processor configuration to create are not null,if esbCaterory, esbService or name are not null |
Deletes a ProcessorAction entity based on the specified ProcessorAction object.
Input Parameters
name |
type |
description |
processorAction |
processorAction
|
The ProcessorAction object to delete. |
Faults
name |
description |
ProcessorWebServiceFault |
If the ProcessorConfiguration object is null or if the specified primary keycontains a null value. |
Method deletes processor action using its primary key.
Input Parameters
name |
type |
description |
processorActionPrimaryKey |
integer |
processor action to delete primary key. |
Faults
name |
description |
ProcessorWebServiceFault |
if the ProcessorAction primary key is null or not found. |
Deletes a ProcessorAction entity based on the specified UUID.
Input Parameters
name |
type |
description |
uuid |
string |
(no documentation provided) |
Faults
name |
description |
ProcessorWebServiceFault |
If the specified UUID contains a null or empty value. |
Deletes a ProcessorConfiguration entity based on the specified primary key.
Input Parameters
name |
type |
description |
processorConfigurationPrimaryKey |
integer |
The Primary Key java.lang.Integer of the ProcessorConfiguration to delete. |
Faults
name |
description |
ProcessorWebServiceFault |
If the specified processorConfigurationPrimaryKey contains a null or empty value or whenProcessorConfiguration is not found. |
Deletes a ProcessorConfiguration entity based on the specified UUID.
Input Parameters
name |
type |
description |
uuid |
string |
(no documentation provided) |
Faults
name |
description |
ProcessorWebServiceFault |
If the specified UUID contains a null or empty value. |
Retrieves an active ProcessorAction by its UUID.
Input Parameters
name |
type |
description |
uuid |
string |
The UUID of the ProcessorAction to search for. |
Return Value
type |
description |
processorAction
|
The active ProcessorAction class that is associated to the specified UUID. If no ProcessorAction was found - anull value is returned. |
Faults
name |
description |
ProcessorWebServiceFault |
business exception that will be thrown if uuid is null or some unexpected application error occurs. |
Retrieves a ProcessorAction by its UUID.
Input Parameters
name |
type |
description |
uuid |
string |
The UUID of the ProcessorAction to search for. |
Return Value
type |
description |
processorAction
|
The ProcessorAction entity that is associated to the specified UUID. If no ProcessorAction was found - anull value is returned. |
Faults
name |
description |
ProcessorWebServiceFault |
business exception that will be thrown if uuid is null or some unexpected application error occurs. |
Gets a list of ProcessorAction by serviceName and categoryName.
Input Parameters
name |
type |
description |
serviceName |
string |
The service name of the ProcessorAction to match. |
categoryName |
string |
The category name of the ProcessorAction to match. |
Return Value
type |
description |
list<processorAction>
|
The ProcessorAction entity that is associated to the specified service name and category name fields. |
Faults
name |
description |
ProcessorWebServiceFault |
business exception that will be thrown if some unexpected application error occurs. |
Gets a ProcessorConfiguration by its UUID.
Input Parameters
name |
type |
description |
uuid |
string |
The UUID value of the processor configuration to search for. |
Return Value
type |
description |
processorConfiguration
|
The ProcessorConfiguration class that is associated to the specified UUID field. If no ProcessorConfiguration wasfound - a null value is returned. |
Faults
name |
description |
ProcessorWebServiceFault |
business exception that will be thrown if uuid is null or some unexpected application error occurs. |
Gets a list of ProcessorConfiguration by serviceName and categoryName.
Input Parameters
name |
type |
description |
serviceName |
string |
The service name of the ProcessorConfiguration to match. |
categoryName |
string |
The category name of the ProcessorConfiguration to match. |
Return Value
type |
description |
list<processorConfiguration>
|
The ProcessorConfiguration entity that is associated to the specified service name and category name fields. |
Faults
name |
description |
ProcessorWebServiceFault |
business exception that will be thrown if some unexpected application error occurs. |
Updates a processor action with values in the specified ProcessorAction object.
Input Parameters
name |
type |
description |
processorActionForUpdate |
processorAction
|
The ProcessorAction object to update. |
Return Value
Faults
name |
description |
ProcessorWebServiceFault |
If the ProcessorAction does not exist or if the UUID field has been modified or an error occurswhen trying to update the ProcessorAction. |
Updates a processor configuration with values in the specified ProcessorConfiguration object.
Input Parameters
name |
type |
description |
processorConfigurationForUpdate |
processorConfiguration
|
The ProcessorConfiguration object to update. |
Return Value
Faults
name |
description |
ProcessorWebServiceFault |
If the ProcessorConfiguration does not exist or if the UUID field has been modified or an erroroccurs when trying to update the processor configuration. |