com.silverpeas.workflow.api.user
Interface UserSettings

All Known Implementing Classes:

UserSettingsImpl

public interface UserSettings

Method Summary

String	getPeasId() Get the peas id
String	getSettingsId() For persistence in database Get this object id
String	getUserId() Get the user id
UserInfo	getUserInfo(String name)
UserInfo[]	getUserInfos()
boolean	isValid() return true if userInfos is not empty
void	load(DataRecord data, RecordTemplate template) Fill the given data record with user information
void	save() Saves this settings in database
void	update(DataRecord data, RecordTemplate template) Update the settings with a given DataRecord

Method Detail

isValid

boolean isValid()

return true if userInfos is not empty

getSettingsId

String getSettingsId()

For persistence in database Get this object id

Returns:

this object id

getUserId

String getUserId()

Get the user id

Returns:

user id

getPeasId

String getPeasId()

Get the peas id

Returns:

peas id

getUserInfos

UserInfo[] getUserInfos()

Returns:

UserInfo[]

getUserInfo

UserInfo getUserInfo(String name)

Returns:

UserInfo

load

void load(DataRecord data,
          RecordTemplate template)

Fill the given data record with user information

Parameters:

data - the data record

template - the record template

save

void save()
          throws WorkflowException

Saves this settings in database

Throws:

WorkflowException

update

void update(DataRecord data,
            RecordTemplate template)

Update the settings with a given DataRecord

Parameters:

data - the data record

template - the record template