org.opencrx.kernel.home1.cci2
Interface UserHome

All Superinterfaces:

AlertSender, Auditee, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, Importer, SecureObject, org.openmdx.compatibility.view1.cci2.ViewCapable, WorkflowTarget

All Known Subinterfaces:

UserHome

All Known Implementing Classes:

UserHome

public interface UserHome
extends AlertSender, Auditee, Importer, SecureObject, WorkflowTarget, org.openmdx.base.cci2.BasicObject

Class UserHome

Nested Class Summary

static interface

UserHome.Identity Object Identity

Method Summary

<T extends ChangePasswordResult> T	changePassword(String newPassword, String newPasswordVerification, String oldPassword)
<T extends AccessHistory> Collection<T>	getAccessHistory() Retrieves a set containing all the elements for the reference accessHistory.
<T extends Alert> Collection<T>	getAlert() Retrieves a set containing all the elements for the reference alert.
<T extends Activity> Set<T>	getAssignedActivity() Retrieves a set containing all the elements for the reference assignedActivity.
<T extends AbstractContract> Set<T>	getAssignedContract() Retrieves a set containing all the elements for the reference assignedContract.
<T extends Chart> Collection<T>	getChart() Retrieves a set containing all the elements for the reference chart.
Chart	getChart0() Retrieves the value for the reference chart0.
Chart	getChart1() Retrieves the value for the reference chart1.
Chart	getChart2() Retrieves the value for the reference chart2.
Chart	getChart3() Retrieves the value for the reference chart3.
Contact	getContact() Retrieves the value for the reference contact.
<T extends EmailAccount> Collection<T>	getEmailAccount() Retrieves a set containing all the elements for the reference eMailAccount.
byte[]	getFavoriteChart0() Retrieves the value for the attribute favoriteChart0.
String	getFavoriteChart0Description()
String	getFavoriteChart0MimeType()
String	getFavoriteChart0Name()
byte[]	getFavoriteChart1() Retrieves the value for the attribute favoriteChart1.
String	getFavoriteChart1Description()
String	getFavoriteChart1MimeType()
String	getFavoriteChart1Name()
byte[]	getFavoriteChart2() Retrieves the value for the attribute favoriteChart2.
String	getFavoriteChart2Description()
String	getFavoriteChart2MimeType()
String	getFavoriteChart2Name()
byte[]	getFavoriteChart3() Retrieves the value for the attribute favoriteChart3.
String	getFavoriteChart3Description()
String	getFavoriteChart3MimeType()
String	getFavoriteChart3Name()
PrincipalGroup	getPrimaryGroup() Retrieves the value for the reference primaryGroup.
<T extends QuickAccess> Collection<T>	getQuickAccess() Retrieves a set containing all the elements for the reference quickAccess.
String	getSendMailSubjectPrefix()
String	getSettings()
<T extends Subscription> Collection<T>	getSubscription() Retrieves a set containing all the elements for the reference subscription.
String	getWebAccessUrl()
<T extends WfProcessInstance> Collection<T>	getWfProcessInstance() Retrieves a set containing all the elements for the reference wfProcessInstance.
byte[]	getWorkWeek() Retrieves the value for the attribute workWeek.
String	getWorkWeekMimeType()
String	getWorkWeekName()
Boolean	isStoreSettingsOnLogoff()
<T extends org.openmdx.base.cci2.Void> T	refreshItems()
void	setChart0(Chart chart0) Sets a new value for the reference chart0.
void	setChart1(Chart chart1) Sets a new value for the reference chart1.
void	setChart2(Chart chart2) Sets a new value for the reference chart2.
void	setChart3(Chart chart3) Sets a new value for the reference chart3.
void	setContact(Contact contact) Sets a new value for the reference contact.
void	setPrimaryGroup(PrincipalGroup primaryGroup) Sets a new value for the reference primaryGroup.
void	setSegment(Segment segment) Sets a new value for the reference segment.
void	setSegment(Segment segment, boolean principalIdIsPersistent, String principalId) Set the object's composite association org:opencrx:kernel:home1:SegmentContainsUserHome.
void	setSendMailSubjectPrefix(String sendMailSubjectPrefix) Sets a new value for the attribute sendMailSubjectPrefix.
void	setSettings(String settings) Sets a new value for the attribute settings.
void	setStoreSettingsOnLogoff(Boolean storeSettingsOnLogoff) Sets a new value for the attribute storeSettingsOnLogoff.
void	setWebAccessUrl(String webAccessUrl) Sets a new value for the attribute webAccessUrl.

Methods inherited from interface org.opencrx.kernel.base.cci2.AlertSender

sendAlert

Methods inherited from interface org.opencrx.kernel.base.cci2.Auditee

getAudit

Methods inherited from interface org.opencrx.kernel.base.cci2.Importer

importItem

Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject

addOwningGroup, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.base.cci2.WorkflowTarget

executeWorkflow

Methods inherited from interface org.openmdx.base.cci2.BasicObject

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci2.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable

getView

Method Detail

getAccessHistory

<T extends AccessHistory> Collection<T> getAccessHistory()

Retrieves a set containing all the elements for the reference accessHistory.

Returns:

A set containing all the elements for this reference.

getAlert

<T extends Alert> Collection<T> getAlert()

Retrieves a set containing all the elements for the reference alert.

Returns:

A set containing all the elements for this reference.

getAssignedActivity

<T extends Activity> Set<T> getAssignedActivity()

Retrieves a set containing all the elements for the reference assignedActivity.

Returns:

A set containing all the elements for this reference.

getAssignedContract

<T extends AbstractContract> Set<T> getAssignedContract()

Retrieves a set containing all the elements for the reference assignedContract.

Returns:

A set containing all the elements for this reference.

changePassword

<T extends ChangePasswordResult> T changePassword(String newPassword,
                                                  String newPasswordVerification,
                                                  String oldPassword)
                                              throws RefException

Throws:

RefException

getChart

<T extends Chart> Collection<T> getChart()

Retrieves a set containing all the elements for the reference chart.

Returns:

A set containing all the elements for this reference.

getChart0

Chart getChart0()

Retrieves the value for the reference chart0.

Returns:

The – possibly null – value for this reference.

setChart0

void setChart0(Chart chart0)

Sets a new value for the reference chart0.

Parameters:

chart0 - The non-null new value for this reference.

getChart1

Chart getChart1()

Retrieves the value for the reference chart1.

Returns:

The – possibly null – value for this reference.

setChart1

void setChart1(Chart chart1)

Sets a new value for the reference chart1.

Parameters:

chart1 - The non-null new value for this reference.

getChart2

Chart getChart2()

Retrieves the value for the reference chart2.

Returns:

The – possibly null – value for this reference.

setChart2

void setChart2(Chart chart2)

Sets a new value for the reference chart2.

Parameters:

chart2 - The non-null new value for this reference.

getChart3

Chart getChart3()

Retrieves the value for the reference chart3.

Returns:

The – possibly null – value for this reference.

setChart3

void setChart3(Chart chart3)

Sets a new value for the reference chart3.

Parameters:

chart3 - The non-null new value for this reference.

getContact

Contact getContact()

Retrieves the value for the reference contact.

Returns:

The – possibly null – value for this reference.

setContact

void setContact(Contact contact)

Sets a new value for the reference contact.

Parameters:

contact - The non-null new value for this reference.

getEmailAccount

<T extends EmailAccount> Collection<T> getEmailAccount()

Retrieves a set containing all the elements for the reference eMailAccount.

Returns:

A set containing all the elements for this reference.

getFavoriteChart0

byte[] getFavoriteChart0()

Retrieves the value for the attribute favoriteChart0.

Returns:

The non-null value for attribute favoriteChart0.

getFavoriteChart0Description

String getFavoriteChart0Description()

Returns:

The possibly null value for attribute favoriteChart0Description.

getFavoriteChart0MimeType

String getFavoriteChart0MimeType()

Returns:

The possibly null value for attribute favoriteChart0MimeType.

getFavoriteChart0Name

String getFavoriteChart0Name()

Returns:

The possibly null value for attribute favoriteChart0Name.

getFavoriteChart1

byte[] getFavoriteChart1()

Retrieves the value for the attribute favoriteChart1.

Returns:

The non-null value for attribute favoriteChart1.

getFavoriteChart1Description

String getFavoriteChart1Description()

Returns:

The possibly null value for attribute favoriteChart1Description.

getFavoriteChart1MimeType

String getFavoriteChart1MimeType()

Returns:

The possibly null value for attribute favoriteChart1MimeType.

getFavoriteChart1Name

String getFavoriteChart1Name()

Returns:

The possibly null value for attribute favoriteChart1Name.

getFavoriteChart2

byte[] getFavoriteChart2()

Retrieves the value for the attribute favoriteChart2.

Returns:

The non-null value for attribute favoriteChart2.

getFavoriteChart2Description

String getFavoriteChart2Description()

Returns:

The possibly null value for attribute favoriteChart2Description.

getFavoriteChart2MimeType

String getFavoriteChart2MimeType()

Returns:

The possibly null value for attribute favoriteChart2MimeType.

getFavoriteChart2Name

String getFavoriteChart2Name()

Returns:

The possibly null value for attribute favoriteChart2Name.

getFavoriteChart3

byte[] getFavoriteChart3()

Retrieves the value for the attribute favoriteChart3.

Returns:

The non-null value for attribute favoriteChart3.

getFavoriteChart3Description

String getFavoriteChart3Description()

Returns:

The possibly null value for attribute favoriteChart3Description.

getFavoriteChart3MimeType

String getFavoriteChart3MimeType()

Returns:

The possibly null value for attribute favoriteChart3MimeType.

getFavoriteChart3Name

String getFavoriteChart3Name()

Returns:

The possibly null value for attribute favoriteChart3Name.

getPrimaryGroup

PrincipalGroup getPrimaryGroup()

Retrieves the value for the reference primaryGroup.

Returns:

The – possibly null – value for this reference.

setPrimaryGroup

void setPrimaryGroup(PrincipalGroup primaryGroup)

Sets a new value for the reference primaryGroup.

Parameters:

primaryGroup - The non-null new value for this reference.

getQuickAccess

<T extends QuickAccess> Collection<T> getQuickAccess()

Retrieves a set containing all the elements for the reference quickAccess.

Returns:

A set containing all the elements for this reference.

refreshItems

<T extends org.openmdx.base.cci2.Void> T refreshItems()
                                                  throws RefException

Throws:

RefException

getSendMailSubjectPrefix

String getSendMailSubjectPrefix()

Returns:

The possibly null value for attribute sendMailSubjectPrefix.

setSendMailSubjectPrefix

void setSendMailSubjectPrefix(String sendMailSubjectPrefix)

Sets a new value for the attribute sendMailSubjectPrefix.

Parameters:

sendMailSubjectPrefix - The possibly null new value for attribute sendMailSubjectPrefix.

getSettings

String getSettings()

Returns:

The possibly null value for attribute settings.

setSettings

void setSettings(String settings)

Sets a new value for the attribute settings.

Parameters:

settings - The possibly null new value for attribute settings.

isStoreSettingsOnLogoff

Boolean isStoreSettingsOnLogoff()

Returns:

The possibly null value for attribute storeSettingsOnLogoff.

setStoreSettingsOnLogoff

void setStoreSettingsOnLogoff(Boolean storeSettingsOnLogoff)

Sets a new value for the attribute storeSettingsOnLogoff.

Parameters:

storeSettingsOnLogoff - The possibly null new value for attribute storeSettingsOnLogoff.

getSubscription

<T extends Subscription> Collection<T> getSubscription()

Retrieves a set containing all the elements for the reference subscription.

Returns:

A set containing all the elements for this reference.

getWebAccessUrl

String getWebAccessUrl()

Returns:

The possibly null value for attribute webAccessUrl.

setWebAccessUrl

void setWebAccessUrl(String webAccessUrl)

Sets a new value for the attribute webAccessUrl.

Parameters:

webAccessUrl - The possibly null new value for attribute webAccessUrl.

getWfProcessInstance

<T extends WfProcessInstance> Collection<T> getWfProcessInstance()

Retrieves a set containing all the elements for the reference wfProcessInstance.

Returns:

A set containing all the elements for this reference.

getWorkWeek

byte[] getWorkWeek()

Retrieves the value for the attribute workWeek.

Returns:

The non-null value for attribute workWeek.

getWorkWeekMimeType

String getWorkWeekMimeType()

Returns:

The possibly null value for attribute workWeekMimeType.

getWorkWeekName

String getWorkWeekName()

Returns:

The possibly null value for attribute workWeekName.

setSegment

void setSegment(Segment segment)

Sets a new value for the reference segment.

Parameters:

segment - The non-null new value for this reference.

setSegment

void setSegment(Segment segment,
                boolean principalIdIsPersistent,
                String principalId)

Set the object's composite association org:opencrx:kernel:home1:SegmentContainsUserHome.

Parameters:

segment - The non-null new value for this object's composite owner.

principalIdIsPersistent - Defines whether the principalId is persistent.

principalId - The non-null new value for this object's qualifier.