com.ibm.etools.sfm.sfpi
Interface SFOperationsFile


public interface SFOperationsFile

The SFOperationsFile interface provides methods to allow easy addition of operations to an operations file.


Method Summary
 void addOperation(SFOperation operation)
          Adds an operation to this operations file.
 java.lang.String getName()
           
 java.util.List<SFOperation> getOperations()
           
 void save()
          Saves the operations file.
 void setName(java.lang.String name)
          Sets the name of the operations file.
 

Method Detail

getName

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

setName

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

Parameters:
name - The name of the file. The name must not include the path. If the name does not include the ".wsdl" extension, the ".wsdl" extension will be added.
Throws:
SFException - In case the supplied name is not valid, 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.
WZEF1300E_FILENAMENOTVALID The file name is not a valid file name. ERROR: The name was not set successfully.

getOperations

java.util.List<SFOperation> getOperations()
Returns:
The list of operations contained in this operations file.

addOperation

void addOperation(SFOperation operation)
                  throws SFException
Adds an operation to this operations file.

Parameters:
operation - An operation.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The operation is null. ERROR: The operation was not added successfully.
WZEF1206E_OPERATIONNAMECONFLICT The operations file contains at least two operations with the same name. ERROR: The operation was not added successfully.

save

void save()
          throws SFException
Saves the operations file.

Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1202E_OPERATIONNOTNAMED An operation in the file is not named. ERROR: The operations file was not saved successfully.
WZEF1203E_OPERATIONHASNOINPUT An operation in the file has no input. ERROR: The operations file was not saved successfully.
WZEF1204E_OPERATIONHASNOOUTPUT An operation in the file has no output. ERROR: The operations file was not saved successfully.
WZEF1205E_BADMESSAGEREF The operations file references a message that is not associated with a message file. ERROR: The operations file was not saved successfully.