com.sapportals.wcm.util.controlstatus

Interface IField

All Known Subinterfaces:

IExecutable, IMandatoryField, ISelectionField

All Known Implementing Classes:

ExecutableField, Field, MandatoryField, MultiValueField, PrincipalsField, ReadOnlyField, SelectionField

public interface IField

encapsulates all information necessary to render an attribute for a service, data object etc. and to update this information. An IControlStatus holds a number of these instances and uses them to communicate with a rendering framework

Method Summary

String	getCurrentValue() returns the current value defined for this field
FieldIdentifier	getIdentifier() returns the identifier set when constructing the implementing class.
String	getMetaInfo(MetaInfo info) returns a localized message to render or an URL-style string that points to a resource to load.
StatusInformation	getStatusInformation() returns the status information for this field.
boolean	isReadOnly() flag to tell, if the value of the implementing class can be updated
void	setCurrentValue(String value) allows to update the current value for this field.

Method Detail

getIdentifier

FieldIdentifier getIdentifier()

returns the identifier set when constructing the implementing class. This identifier must be unique within one IControlStatus .

Returns:

identifier

isReadOnly

boolean isReadOnly()

flag to tell, if the value of the implementing class can be updated

Returns:

readOnly

getCurrentValue

String getCurrentValue()

returns the current value defined for this field

Returns:

currentValue

getMetaInfo

String getMetaInfo(MetaInfo info)

returns a localized message to render or an URL-style string that points to a resource to load.

Parameters:

info - TBD: Description of the incoming method parameter

Returns:

metaInfo

setCurrentValue

void setCurrentValue(String value)

allows to update the current value for this field. If the input does not adhere to certain restrictions defined for this field, the input might not be set.

Parameters:

value - currentValue to be set

getStatusInformation

StatusInformation getStatusInformation()

returns the status information for this field. If e.g. an invalid value was set, this method would return a detailed, localized message and the severity of this error.

Returns:

statusInformation

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM