org.diirt.support.pva.rpcservice

Class RPCServiceMethodDescription

java.lang.Object

org.diirt.service.ServiceMethodDescription

org.diirt.support.pva.rpcservice.RPCServiceMethodDescription

public class RPCServiceMethodDescription
extends ServiceMethodDescription

The description for a pvAccess RPC rpcservice method.

Author:

dkumar

Constructor Summary

Constructors

Constructor and Description
RPCServiceMethodDescription(String name, String description, String operationName, String structureId, boolean isResultStandalone) A new rpcservice method with the given name and description.

Method Summary

Modifier and Type	Method and Description
RPCServiceMethodDescription	addArgument(String name, String fieldName, String description, Class<?> type) Adds an argument for pvAccess RPC rpcservice.
RPCServiceMethodDescription	addRPCResult(String name, String fieldName, String description, Class<?> type) Adds a result for the pvAccess RPC Service.
ServiceMethod	createServiceMethod(ServiceDescription serviceDescription) Creates a service method with the given description.
Map<String,String>	getFieldNames() Get field names
String	getOperationName() Get operation name
String	getStructureId() Get structure id

Methods inherited from class org.diirt.service.ServiceMethodDescription

addArgument, addResult

Methods inherited from class java.lang.Object

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

Constructor Detail

RPCServiceMethodDescription

public RPCServiceMethodDescription(String name,
                                   String description,
                                   String operationName,
                                   String structureId,
                                   boolean isResultStandalone)

A new rpcservice method with the given name and description.

Parameters:

name - the method name

description - the method description

operationName - operation name

structureId - pvStructure id

isResultStandalone - is result standalone i.e. image, table

Method Detail

getStructureId

public String getStructureId()

Get structure id

Returns:

structure id

getOperationName

public String getOperationName()

Get operation name

Returns:

operation name

getFieldNames

public Map<String,String> getFieldNames()

Get field names

Returns:

field names

addArgument

public RPCServiceMethodDescription addArgument(String name,
                                               String fieldName,
                                               String description,
                                               Class<?> type)

Adds an argument for pvAccess RPC rpcservice.

Parameters:

name - argument name

description - argument description

type - the expected type of the argument

Returns:

this

addRPCResult

public RPCServiceMethodDescription addRPCResult(String name,
                                                String fieldName,
                                                String description,
                                                Class<?> type)

Adds a result for the pvAccess RPC Service.

Parameters:

name - the result name

description - the result description

Returns:

this

createServiceMethod

public ServiceMethod createServiceMethod(ServiceDescription serviceDescription)

Description copied from class: ServiceMethodDescription

Creates a service method with the given description.

A client should implement this to return their service method implementation.

Specified by:

createServiceMethod in class ServiceMethodDescription

Parameters:

serviceDescription - service description for the new service method

Returns:

a new service method