com.sap.sdm.api.remote
Interface DynSizeParamContainer

All Superinterfaces:

AbstractParamContainer

public interface DynSizeParamContainer

extends AbstractParamContainer

A container for a variable number of Param objects. In a DynSizeParamContainer, Param objects can be added and removed.

Version:

1.0

Method Summary

void	addParam(Param param) Adds a Param to this DynSizeParamContainer.
boolean	canAddParam(Param param) Indicates whether the specified Param can be added to this DynSizeParamContainer.
boolean	canRemoveParam(Param param) Indicates whether the specified Param can be removed from this DynSizeParamContainer.
boolean	canRemoveParamByName(java.lang.String name) Indicates whether a Param with the specified name can be removed from this DynSizeParamContainer.
void	removeParam(Param param) Removes the specified Param from this DynSizeParamContainer.
void	removeParamByName(java.lang.String name) Removes a Param with the specified name from this DynSizeParamContainer.

Methods inherited from interface com.sap.sdm.api.remote.AbstractParamContainer

getParamByName, getParams, save

Method Detail

canAddParam

public boolean canAddParam(Param param)
                    throws RemoteException

Indicates whether the specified Param can be added to this DynSizeParamContainer. The specified Param can be added if this DynSizeParamContainer contains no Param with identical name. When container is used to store substitutional variables, this method returns false in case where one tries to add dynamic substitutional variable - this is only done internally by the SDM itself.

Parameters:

param - the Param to be added

Returns:

true if param can be added; false otherwise

Throws:

NullPointerException - if param is null

addParam

public void addParam(Param param)
              throws RemoteException

Adds a Param to this DynSizeParamContainer.

Parameters:

param - the Param to be added

Throws:

java.lang.IllegalArgumentException - if param cannot be added

NullPointerException - if param is null

canRemoveParam

public boolean canRemoveParam(Param param)
                       throws RemoteException

Indicates whether the specified Param can be removed from this DynSizeParamContainer. The specified Param can be removed from this DynSizeParamContainer if it is contained in this DynSizeParamContainer.

Parameters:

param - the Param to be removed

Returns:

true if param can be removed; false otherwise

Throws:

NullPointerException - if param is null

removeParam

public void removeParam(Param param)
                 throws RemoteException

Removes the specified Param from this DynSizeParamContainer.

Parameters:

param - the Param to be removed

Throws:

java.lang.IllegalArgumentException - if param cannot be removed

NullPointerException - if param is null

canRemoveParamByName

public boolean canRemoveParamByName(java.lang.String name)
                             throws RemoteException

Indicates whether a Param with the specified name can be removed from this DynSizeParamContainer. A Param with the specified name can be removed from this DynSizeParamContainer if this DynSizeParamContainer contains a Param with the specified name.

Parameters:

name - the name of the Param to be removed

Returns:

true if a Param with the specified name can be removed; false otherwise

Throws:

NullPointerException - if name is null

removeParamByName

public void removeParamByName(java.lang.String name)
                       throws RemoteException

Removes a Param with the specified name from this DynSizeParamContainer.

Parameters:

name - the name of the Param to be removed

Throws:

java.lang.IllegalArgumentException - if no Param with the specified name can be removed

NullPointerException - if name is null