com.sapportals.wcm.util.controlstatus

Class PrincipalsField

java.lang.Object
  com.sapportals.wcm.util.controlstatus.Field
      com.sapportals.wcm.util.controlstatus.PrincipalsField

All Implemented Interfaces:

IField

public class PrincipalsField
extends Field

TBD: Description of the class.

Constructor Summary

PrincipalsField(FieldIdentifier id, String currentvalue, HashMap metainfo, boolean readonly, Locale locale, boolean email, boolean unchecked)

PrincipalsField(FieldIdentifier id, String currentvalue, HashMap metainfo, 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

void	addPrincipalsToList(String[] ids, int typeoflist)
void	addPrincipalToList(String id, int typeoflist)
String	getCurrentValue() inherited from Field
String[]	getIDs(int typeoflist)
String	getInvalidIDs()
String[]	getNonUniqueIDs(int typeoflist)
boolean	isInvalidIDGiven()
boolean	isNonUniqueIDGiven()
void	reset() clears all prior settings by creating a new instance of a SelectionUserManager
void	setCurrentValue(String value) inherited from Field

Methods inherited from class com.sapportals.wcm.util.controlstatus.Field

getIdentifier, getInitialValue, getMetaInfo, getStatusInformation, isReadOnly

Methods inherited from class java.lang.Object

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

Constructor Detail

PrincipalsField

public PrincipalsField(FieldIdentifier id,
                       String currentvalue,
                       HashMap metainfo,
                       boolean readonly,
                       Locale locale,
                       boolean email,
                       boolean unchecked)

PrincipalsField

public PrincipalsField(FieldIdentifier id,
                       String currentvalue,
                       HashMap metainfo,
                       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

addPrincipalToList

public void addPrincipalToList(String id,
                               int typeoflist)
                        throws WcmException

Throws:

WcmException

addPrincipalsToList

public void addPrincipalsToList(String[] ids,
                                int typeoflist)
                         throws WcmException

Throws:

WcmException

getIDs

public String[] getIDs(int typeoflist)

isInvalidIDGiven

public boolean isInvalidIDGiven()

isNonUniqueIDGiven

public boolean isNonUniqueIDGiven()

getInvalidIDs

public String getInvalidIDs()

getNonUniqueIDs

public String[] getNonUniqueIDs(int typeoflist)
                         throws WcmException

Throws:

WcmException

reset

public void reset()

clears all prior settings by creating a new instance of a SelectionUserManager

getCurrentValue

public String getCurrentValue()

inherited from Field

Specified by:

getCurrentValue in interface IField

Overrides:

getCurrentValue in class Field

Returns:

currentValue

setCurrentValue

public void setCurrentValue(String value)

inherited from Field

Specified by:

setCurrentValue in interface IField

Overrides:

setCurrentValue in class Field

Parameters:

value - currentValue to be set

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