org.opencrx.kernel.home1.cci2
Interface UserHome

All Superinterfaces:

AlertSender, AspectCapable, Auditee, BasicObject, ContextCapable, Creatable, ExtentCapable, Importer, Modifiable, SecureObject, WorkflowTarget

All Known Subinterfaces:

UserHome

All Known Implementing Classes:

UserHome

public interface UserHome
extends AlertSender, Auditee, Importer, SecureObject, WorkflowTarget, BasicObject

Class UserHome

Nested Class Summary

static interface

UserHome.Identity Object Identity

Method Summary

ChangePasswordResult	changePassword(ChangePasswordParams in)
<T extends AccessHistory> UserHomeContainsAccessHistory.AccessHistory<T>	getAccessHistory() Retrieves a set containing all the elements for the reference accessHistory.
<T extends Alert> UserHomeContainsAlert.Alert<T>	getAlert() Retrieves a set containing all the elements for the reference alert.
<T extends Activity> UserHomeHasAssignedActivity.AssignedActivity<T>	getAssignedActivity() Retrieves a set containing all the elements for the reference assignedActivity.
<T extends AbstractContract> UserHomeHasAssignedContract.AssignedContract<T>	getAssignedContract() Retrieves a set containing all the elements for the reference assignedContract.
<T extends CalendarProfile> UserHomeContainsCalendarProfile.CalendarProfile<T>	getCalendarProfile() Retrieves a set containing all the elements for the reference calendarProfile.
<T extends Media> UserHomeContainsChart.Chart<T>	getChart() Retrieves a set containing all the elements for the reference chart.
Media	getChart0() Retrieves the value for the reference chart0.
Media	getChart1() Retrieves the value for the reference chart1.
Media	getChart2() Retrieves the value for the reference chart2.
Media	getChart3() Retrieves the value for the reference chart3.
Contact	getContact() Retrieves the value for the reference contact.
<T extends EmailAccount> UserHomeContainsEmailAccount.EMailAccount<T>	getEmailAccount() Retrieves a set containing all the elements for the reference eMailAccount.
<T extends ExportProfile> UserHomeContainsExportProfile.ExportProfile<T>	getExportProfile() Retrieves a set containing all the elements for the reference exportProfile.
byte[]	getFavoriteChart0() Retrieves the value for the attribute favoriteChart0.
String	getFavoriteChart0Description() Retrieves the possibly null value for the optional attribute favoriteChart0Description.
String	getFavoriteChart0MimeType() Retrieves the possibly null value for the optional attribute favoriteChart0MimeType.
String	getFavoriteChart0Name() Retrieves the possibly null value for the optional attribute favoriteChart0Name.
byte[]	getFavoriteChart1() Retrieves the value for the attribute favoriteChart1.
String	getFavoriteChart1Description() Retrieves the possibly null value for the optional attribute favoriteChart1Description.
String	getFavoriteChart1MimeType() Retrieves the possibly null value for the optional attribute favoriteChart1MimeType.
String	getFavoriteChart1Name() Retrieves the possibly null value for the optional attribute favoriteChart1Name.
byte[]	getFavoriteChart2() Retrieves the value for the attribute favoriteChart2.
String	getFavoriteChart2Description() Retrieves the possibly null value for the optional attribute favoriteChart2Description.
String	getFavoriteChart2MimeType() Retrieves the possibly null value for the optional attribute favoriteChart2MimeType.
String	getFavoriteChart2Name() Retrieves the possibly null value for the optional attribute favoriteChart2Name.
byte[]	getFavoriteChart3() Retrieves the value for the attribute favoriteChart3.
String	getFavoriteChart3Description() Retrieves the possibly null value for the optional attribute favoriteChart3Description.
String	getFavoriteChart3MimeType() Retrieves the possibly null value for the optional attribute favoriteChart3MimeType.
String	getFavoriteChart3Name() Retrieves the possibly null value for the optional attribute favoriteChart3Name.
<T extends ObjectFinder> UserHomeContainsObjectFinder.ObjectFinder<T>	getObjectFinder() Retrieves a set containing all the elements for the reference objectFinder.
PrincipalGroup	getPrimaryGroup() Retrieves the value for the reference primaryGroup.
<T extends QuickAccess> UserHomeContainsQuickAccess.QuickAccess<T>	getQuickAccess() Retrieves a set containing all the elements for the reference quickAccess.
String	getSendMailSubjectPrefix() Retrieves the possibly null value for the optional attribute sendMailSubjectPrefix.
String	getSettings() Retrieves the possibly null value for the optional attribute settings.
<T extends Subscription> UserHomeContainsSubscription.Subscription<T>	getSubscription() Retrieves a set containing all the elements for the reference subscription.
String	getWebAccessUrl() Retrieves the possibly null value for the optional attribute webAccessUrl.
<T extends WfProcessInstance> UserHomeContainsWfProcessInstance.WfProcessInstance<T>	getWfProcessInstance() Retrieves a set containing all the elements for the reference wfProcessInstance.
byte[]	getWorkWeek() Retrieves the value for the attribute workWeek.
String	getWorkWeekMimeType() Retrieves the possibly null value for the optional attribute workWeekMimeType.
String	getWorkWeekName() Retrieves the possibly null value for the optional attribute workWeekName.
Boolean	isStoreSettingsOnLogoff() Retrieves the possibly null value for the optional attribute storeSettingsOnLogoff.
Void	refreshItems()
SearchResult	searchAdvanced(SearchAdvancedParams in)
SearchResult	searchBasic(SearchBasicParams in)
void	setChart0(Media chart0) Sets a new value for the reference chart0.
void	setChart1(Media chart1) Sets a new value for the reference chart1.
void	setChart2(Media chart2) Sets a new value for the reference chart2.
void	setChart3(Media 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	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, checkPermissions, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, 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.ContextCapable

getContext

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

getCreatedAt, getCreatedBy

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

getIdentity

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

getModifiedAt, getModifiedBy

Method Detail

getAccessHistory

<T extends AccessHistory> UserHomeContainsAccessHistory.AccessHistory<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> UserHomeContainsAlert.Alert<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> UserHomeHasAssignedActivity.AssignedActivity<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> UserHomeHasAssignedContract.AssignedContract<T> getAssignedContract()

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

Returns:

A set containing all the elements for this reference.

getCalendarProfile

<T extends CalendarProfile> UserHomeContainsCalendarProfile.CalendarProfile<T> getCalendarProfile()

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

Returns:

A set containing all the elements for this reference.

changePassword

ChangePasswordResult changePassword(ChangePasswordParams in)

getChart

<T extends Media> UserHomeContainsChart.Chart<T> getChart()

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

Returns:

A set containing all the elements for this reference.

getChart0

Media getChart0()

Retrieves the value for the reference chart0.

Returns:

The – possibly null – value for this reference.

setChart0

void setChart0(Media chart0)

Sets a new value for the reference chart0.

Parameters:

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

getChart1

Media getChart1()

Retrieves the value for the reference chart1.

Returns:

The – possibly null – value for this reference.

setChart1

void setChart1(Media chart1)

Sets a new value for the reference chart1.

Parameters:

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

getChart2

Media getChart2()

Retrieves the value for the reference chart2.

Returns:

The – possibly null – value for this reference.

setChart2

void setChart2(Media chart2)

Sets a new value for the reference chart2.

Parameters:

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

getChart3

Media getChart3()

Retrieves the value for the reference chart3.

Returns:

The – possibly null – value for this reference.

setChart3

void setChart3(Media 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> UserHomeContainsEmailAccount.EMailAccount<T> getEmailAccount()

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

Returns:

A set containing all the elements for this reference.

getExportProfile

<T extends ExportProfile> UserHomeContainsExportProfile.ExportProfile<T> getExportProfile()

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

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()

Retrieves the possibly null value for the optional attribute favoriteChart0Description.

Returns:

The possibly null value for attribute favoriteChart0Description.

getFavoriteChart0MimeType

String getFavoriteChart0MimeType()

Retrieves the possibly null value for the optional attribute favoriteChart0MimeType.

Returns:

The possibly null value for attribute favoriteChart0MimeType.

getFavoriteChart0Name

String getFavoriteChart0Name()

Retrieves the possibly null value for the optional attribute favoriteChart0Name.

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()

Retrieves the possibly null value for the optional attribute favoriteChart1Description.

Returns:

The possibly null value for attribute favoriteChart1Description.

getFavoriteChart1MimeType

String getFavoriteChart1MimeType()

Retrieves the possibly null value for the optional attribute favoriteChart1MimeType.

Returns:

The possibly null value for attribute favoriteChart1MimeType.

getFavoriteChart1Name

String getFavoriteChart1Name()

Retrieves the possibly null value for the optional attribute favoriteChart1Name.

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()

Retrieves the possibly null value for the optional attribute favoriteChart2Description.

Returns:

The possibly null value for attribute favoriteChart2Description.

getFavoriteChart2MimeType

String getFavoriteChart2MimeType()

Retrieves the possibly null value for the optional attribute favoriteChart2MimeType.

Returns:

The possibly null value for attribute favoriteChart2MimeType.

getFavoriteChart2Name

String getFavoriteChart2Name()

Retrieves the possibly null value for the optional attribute favoriteChart2Name.

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()

Retrieves the possibly null value for the optional attribute favoriteChart3Description.

Returns:

The possibly null value for attribute favoriteChart3Description.

getFavoriteChart3MimeType

String getFavoriteChart3MimeType()

Retrieves the possibly null value for the optional attribute favoriteChart3MimeType.

Returns:

The possibly null value for attribute favoriteChart3MimeType.

getFavoriteChart3Name

String getFavoriteChart3Name()

Retrieves the possibly null value for the optional attribute favoriteChart3Name.

Returns:

The possibly null value for attribute favoriteChart3Name.

getObjectFinder

<T extends ObjectFinder> UserHomeContainsObjectFinder.ObjectFinder<T> getObjectFinder()

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

Returns:

A set containing all the elements for this reference.

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> UserHomeContainsQuickAccess.QuickAccess<T> getQuickAccess()

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

Returns:

A set containing all the elements for this reference.

refreshItems

Void refreshItems()

searchAdvanced

SearchResult searchAdvanced(SearchAdvancedParams in)

searchBasic

SearchResult searchBasic(SearchBasicParams in)

getSendMailSubjectPrefix

String getSendMailSubjectPrefix()

Retrieves the possibly null value for the optional attribute sendMailSubjectPrefix.

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()

Retrieves the possibly null value for the optional attribute settings.

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()

Retrieves the possibly null value for the optional attribute storeSettingsOnLogoff.

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> UserHomeContainsSubscription.Subscription<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()

Retrieves the possibly null value for the optional attribute webAccessUrl.

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> UserHomeContainsWfProcessInstance.WfProcessInstance<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()

Retrieves the possibly null value for the optional attribute workWeekMimeType.

Returns:

The possibly null value for attribute workWeekMimeType.

getWorkWeekName

String getWorkWeekName()

Retrieves the possibly null value for the optional attribute workWeekName.

Returns:

The possibly null value for attribute workWeekName.