org.opencrx.kernel.home1.cci2
Interface UserHome

All Superinterfaces:
AlertSender, 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

isFrozenisFrozenisFrozenisFrozenisFrozenisFrozenisFrozen


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 Media>
UserHomeContainsChart.Chart<T>
getChart()
          Retrieves a set containing all the elements for the reference chart.
 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.
<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.
<T extends SyncProfile>
UserHomeContainsSyncProfile.SyncProfile<T>
getSyncProfile()
          Retrieves a set containing all the elements for the reference syncProfile.
 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.
 Boolean isStoreSettingsOnLogoff()
          Retrieves the possibly null value for the optional attribute storeSettingsOnLogoff.
 Void refreshItems()
           
 SearchResult searchAdvanced(SearchAdvancedParams in)
           
 SearchResult searchBasic(SearchBasicParams in)
           
 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, setOwner, setOwningUser, setOwningUser
 
Methods inherited from interface org.opencrx.kernel.base.cci2.WorkflowTarget
executeWorkflow
 
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.

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.

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.

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.

getSyncProfile

<T extends SyncProfile> UserHomeContainsSyncProfile.SyncProfile<T> getSyncProfile()
Retrieves a set containing all the elements for the reference syncProfile.

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.


This software is published under the BSD license. Copyright © 2003-2010, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.