com.ibm.etools.sfm.sfpi
Interface SFOperation

All Known Subinterfaces:
SFChannelOperation

public interface SFOperation

SFOperation represents an operation that can have exactly one input and exectly one output.


Method Summary
 java.util.List<SFFault> getFaults()
           
 SFGenerationProperties getGenerationProperties()
           
 SFInput getInput()
           
 java.lang.String getName()
           
 SFOutput getOutput()
           
 void setFaults(java.util.List<SFFault> faults)
          Sets the faults of the operations.
 void setGenerationProperties(SFGenerationProperties genProps)
          Sets the operation's generation properties.
 void setInput(SFInput input)
          Sets the input of the operation.
 void setName(java.lang.String name)
          Sets the name of the operation.
 void setOutput(SFOutput output)
          Sets the output of the operation.
 

Method Detail

getName

java.lang.String getName()
Returns:
The name of the operation.

setName

void setName(java.lang.String name)
             throws SFException
Sets the name of the operation.

Parameters:
name - The name of the operation.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The name is null. ERROR: The name was not set successfully.
WZEF1200E_NAMENOTVALID The operation name is not a valid NCName. ERROR: The name was not set successfully.
WZEF1206E_OPERATIONNAMECONFLICT The operations file contains at least two operations with the same name. (Applies only if the operation is associated with an operations file.) ERROR: The name was not set successfully.

getInput

SFInput getInput()
Returns:
The input of the operation.

setInput

void setInput(SFInput input)
              throws SFException
Sets the input of the operation.

Parameters:
input - The input of the operation.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The input is null. ERROR: The input was not set successfully.
WZEF1201E_CHANNELTYPEMISMATCH An attempt to add a non-channel input or output to a channel operation or an attempt to add a channel input or output to a non-channel operation was detected. ERROR: The input was not set successfully.

getOutput

SFOutput getOutput()
Returns:
The output of the operation.

setOutput

void setOutput(SFOutput output)
               throws SFException
Sets the output of the operation.

Parameters:
output - The output of the operation.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The output is null. ERROR: The output was not set successfully.
WZEF1201E_CHANNELTYPEMISMATCH An attempt to add a non-channel input or output to a channel operation or an attempt to add a channel input or output to a non-channel operation was detected. ERROR: The output was not set successfully.

getFaults

java.util.List<SFFault> getFaults()
Returns:
The faults of the operation.

setFaults

void setFaults(java.util.List<SFFault> faults)
               throws SFException
Sets the faults of the operations.

Parameters:
faults - The faults of the operation.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The faults is null. ERROR: The faults was not set successfully.

getGenerationProperties

SFGenerationProperties getGenerationProperties()
Returns:
The operation's generation properties.

setGenerationProperties

void setGenerationProperties(SFGenerationProperties genProps)
                             throws SFException
Sets the operation's generation properties.

Parameters:
genProps - The generation properties.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The genProps is null. ERROR: The generation properties were not set successfully.