com.sapportals.wcm.util.controlstatus
Class Field

[contained in: com.sap.netweaver.bc.util.par - bc.util.public_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.util.controlstatus.Field

All Implemented Interfaces:

IField

Direct Known Subclasses:

ExecutableField, PrincipalsField, SelectionField

public class Field

extends java.lang.Object

implements IField

TBD: Description of the class.

Constructor Summary

Field(FieldIdentifier id, java.lang.String currentvalue, java.util.HashMap metainfo, boolean readonly, ICondition condition, java.util.Locale locale)

Field(FieldIdentifier id, java.lang.String currentvalue, java.util.HashMap metainfo, java.util.Locale locale)
shortened Constructor, which will set the following values for the dropped parameters readonly will be set to false condition will be set to null

Method Summary

java.lang.String	getCurrentValue() returns the current value defined for this field
FieldIdentifier	getIdentifier() returns the identifier set when constructing the implementing class.
java.lang.String	getInitialValue()
java.lang.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(java.lang.String value) allows to update the current value for this field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Field

public Field(FieldIdentifier id,
             java.lang.String currentvalue,
             java.util.HashMap metainfo,
             boolean readonly,
             ICondition condition,
             java.util.Locale locale)

Field

public Field(FieldIdentifier id,
             java.lang.String currentvalue,
             java.util.HashMap metainfo,
             java.util.Locale locale)

shortened Constructor, which will set the following values for the dropped parameters readonly will be set to false condition will be set to null

Parameters:

id - TBD: Description of the incoming method parameter

currentvalue - TBD: Description of the incoming method parameter

metainfo - TBD: Description of the incoming method parameter

locale - TBD: Description of the incoming method parameter

Method Detail

getIdentifier

public FieldIdentifier getIdentifier()

Description copied from interface: IField

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

Specified by:

getIdentifier in interface IField

Following copied from interface: com.sapportals.wcm.util.controlstatus.IField

Returns:

identifier

isReadOnly

public boolean isReadOnly()

Description copied from interface: IField

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

Specified by:

isReadOnly in interface IField

Following copied from interface: com.sapportals.wcm.util.controlstatus.IField

Returns:

readOnly

getCurrentValue

public java.lang.String getCurrentValue()

Description copied from interface: IField

returns the current value defined for this field

Specified by:

getCurrentValue in interface IField

Following copied from interface: com.sapportals.wcm.util.controlstatus.IField

Returns:

currentValue

getInitialValue

public java.lang.String getInitialValue()

getMetaInfo

public java.lang.String getMetaInfo(MetaInfo info)

Description copied from interface: IField

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

Specified by:

getMetaInfo in interface IField

Following copied from interface: com.sapportals.wcm.util.controlstatus.IField

Parameters:

info - TBD: Description of the incoming method parameter

Returns:

metaInfo

setCurrentValue

public void setCurrentValue(java.lang.String value)

Description copied from interface: IField

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.

Specified by:

setCurrentValue in interface IField

Following copied from interface: com.sapportals.wcm.util.controlstatus.IField

Parameters:

value - currentValue to be set

getStatusInformation

public StatusInformation getStatusInformation()

Description copied from interface: IField

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.

Specified by:

getStatusInformation in interface IField

Following copied from interface: com.sapportals.wcm.util.controlstatus.IField

Returns:

statusInformation