com.sapportals.wcm.service.reporting

Class UserInputList

java.lang.Object
  com.sapportals.wcm.service.reporting.UserInputList

All Implemented Interfaces:

IListInput<UserPair>

public class UserInputList
extends Object
implements IListInput<UserPair>

Constructor Summary

UserInputList(com.sapportals.wcm.util.uri.RID rid)

Method Summary

Set<UserPair>	getInputItems() Get a set of the input parameters
Set<UserPair>	getInvalidInputItems() Gets the set of invalid input items
String	getListPopulationError() Gets the description of the population error that has caused the failure of the population of the input list if such an error exists
com.sapportals.wcm.util.uri.RID	getRID() Gets the RID of the resource that contains the input items
boolean	isListPopulationSuccessful() Checks if the item list has been successfully populated
boolean	validate() validates the input items.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserInputList

public UserInputList(com.sapportals.wcm.util.uri.RID rid)

Method Detail

getInputItems

public Set<UserPair> getInputItems()

Description copied from interface: IListInput

Get a set of the input parameters

Specified by:

getInputItems in interface IListInput<UserPair>

Returns:

the set of the input parameters and null if there are no input items ;

getInvalidInputItems

public Set<UserPair> getInvalidInputItems()

Description copied from interface: IListInput

Gets the set of invalid input items

Specified by:

getInvalidInputItems in interface IListInput<UserPair>

Returns:

set of the invalid input items and null if there are no invalid input items of type

getListPopulationError

public String getListPopulationError()

Description copied from interface: IListInput

Gets the description of the population error that has caused the failure of the population of the input list if such an error exists

Specified by:

getListPopulationError in interface IListInput<UserPair>

Returns:

a string object, containing description of the cause of the failure and null otherwise

getRID

public com.sapportals.wcm.util.uri.RID getRID()

Description copied from interface: IListInput

Gets the RID of the resource that contains the input items

Specified by:

getRID in interface IListInput<UserPair>

Returns:

the rid of the source resource

isListPopulationSuccessful

public boolean isListPopulationSuccessful()

Description copied from interface: IListInput

Checks if the item list has been successfully populated

Specified by:

isListPopulationSuccessful in interface IListInput<UserPair>

Returns:

true if the population has been successful and false otherwise

validate

public boolean validate()

Description copied from interface: IListInput

validates the input items. The method splits the input into two collections - for valid and invalid items

Specified by:

validate in interface IListInput<UserPair>

Returns:

true if all input items are valid and false otherwise

Access Rights

This class can be accessed from:

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