Package com.piketec.tpt.api.steplist

Interface ServiceStepArgument

All Superinterfaces:

java.rmi.Remote, TptRemote

public interface ServiceStepArgument
extends TptRemote

Argument for ServiceStep

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Delivers the name of a service step argument.
Type	getType()	Delivers the Type of a service step argument.
java.lang.String	getValue()	Delivers the value of a service step argument.
boolean	isMandatory()	ServiceStepArgument can be mandatory for using a specific ServiceStep.
void	setValue(java.lang.String value)	Sets a value of a service step argument.

Method Detail

getType

Type getType()
      throws java.rmi.RemoteException

Delivers the Type of a service step argument.

Returns:

Type of a service step argument.

Throws:

java.rmi.RemoteException - remote communication problem

getName

java.lang.String getName()
                  throws java.rmi.RemoteException

Delivers the name of a service step argument.

Returns:

name of a service step argument.

Throws:

java.rmi.RemoteException - remote communication problem

getValue

java.lang.String getValue()
                   throws java.rmi.RemoteException

Delivers the value of a service step argument.

Returns:

value of a service step argument.

Throws:

java.rmi.RemoteException - remote communication problem

setValue

void setValue(java.lang.String value)
       throws java.rmi.RemoteException

Sets a value of a service step argument.

Parameters:

value - New value for service step argument.

Throws:

java.rmi.RemoteException - remote communication problem

isMandatory

boolean isMandatory()
             throws java.rmi.RemoteException

ServiceStepArgument can be mandatory for using a specific ServiceStep. This function determines whether a ServiceStepArgument is mandatory or not. In case a mandatory argument is not provided via TPT API, a compile error will occur for the corresponding step list.

Returns:

true if ServiceStepArgument is mandatory.

Throws:

java.rmi.RemoteException - remote communication problem