com.sap.tc.col.client.generic.api
Interface IValueSet

public interface IValueSet

interface of a ValueSet at runtime.

A ValueSet allows searching for value help to fields of an Aspect. As input of this search exists a input structure, which may only contain Aspect fields. In difference to an IQuery IValueSet returns a IStructureList. An example using a ValueSet could be:

   IValueSet valueSet = aspect.createValueSet("CITY");
   IStructure inputParameter = valueSet.getInputParameter();
   // setting input parameter
   inputParameter.setAttributeValue("COUNTRY", "GERMANY");
   ..
   valueSet.execute();
   // now the result
   IStructureList outValues = valueSet.getOutValues();
   ..
 

Additionally ValueSet implements ICMIQuery and ICMIModelClassExecutable.

This is necessary to use a ValueSet from Web Dynpro. Web Dynpro framework only knows this interfaces and uses the implicit relations ValueSet.INPUT_PARAMETER and ValueSet.OUT_VALUES for setting parameters and getting the outValues of the ValueSet.

Field Summary

static java.lang.String	INPUT_PARAMETER constant string for implicit inputParamter relation role
static java.lang.String	OUT_VALUES constant string for implicit outValues relation role

Method Summary

void	execute() Executes this ValueSet query by calling corresponding ServiceManager service.
IValueSetDescriptor	getDescriptor() returns meta data of this ValueSet
IStructure	getInputParameterStructure() returns the input parameter structure of this ValueSet or throws an UnsupportedOperationException, if this ValueSet has no input parameter.
IStructureList	getOutValuesList() returns the outValues list of this ValueSet

Field Detail

INPUT_PARAMETER

public static final java.lang.String INPUT_PARAMETER

constant string for implicit inputParamter relation role

OUT_VALUES

public static final java.lang.String OUT_VALUES

constant string for implicit outValues relation role

Method Detail

execute

public void execute()

Executes this ValueSet query by calling corresponding ServiceManager service.

Before this is done, eventually existing outValues are overwritten.

getDescriptor

public IValueSetDescriptor getDescriptor()

returns meta data of this ValueSet

Returns:

IValueSetDescriptor meta data of this ValueSet

getOutValuesList

public IStructureList getOutValuesList()

returns the outValues list of this ValueSet

Returns:

IStructureList the outValues list of this ValueSet

getInputParameterStructure

public IStructure getInputParameterStructure()

returns the input parameter structure of this ValueSet or throws an UnsupportedOperationException, if this ValueSet has no input parameter.

Returns:

IStructure the input parameter of this ValueSet

Throws:

throws - an UnsupportedOperationException, if this ValueSet has no input parameter.