org.opencrx.kernel.home1.jdo2
Class UserHome

java.lang.Object
  org.oasisopen.jdo2.Identifiable
      org.w3c.jdo2.AbstractObject
          org.opencrx.kernel.home1.jdo2.UserHome

All Implemented Interfaces:

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

public class UserHome
extends org.w3c.jdo2.AbstractObject
implements UserHome

Class UserHome

See Also:

Serialized Form

Nested Class Summary

static class	UserHome.Identity The object's application identity
static class	UserHome.Slice

Nested classes/interfaces inherited from class org.w3c.jdo2.AbstractObject

org.w3c.jdo2.AbstractObject.BLOB, org.w3c.jdo2.AbstractObject.CLOB, org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>

Field Summary

static List<String>	BASE_CLASS Define this class as base class
static List<String>	CLASS Define the model class org::opencrx::kernel::home1::UserHome

Constructor Summary

UserHome()

Method Summary

<T extends ModifySecureObjectResult> T	addOwningGroup(PrincipalGroup group, short mode)
<T extends ChangePasswordResult> T	changePassword(String newPassword, String newPasswordVerification, String oldPassword)
<T extends ExecuteWorkflowResult> T	executeWorkflow(Date startAt, org.openmdx.base.cci2.BasicObject targetObject, String targetObjectXri, String triggeredByEventId, Integer triggeredByEventType, Subscription triggeredBySubscription, WfProcess workflow)
org.openmdx.base.cci2.BasicObject	getAccessGrantedByParent() Retrieves the value for the reference accessGrantedByParent.
<T extends AccessHistory> Collection<T>	getAccessHistory() Retrieves a set containing all the elements for the reference accessHistory.
short	getAccessLevelBrowse() Retrieves the value for the attribute accessLevelBrowse.
short	getAccessLevelDelete() Retrieves the value for the attribute accessLevelDelete.
short	getAccessLevelUpdate() Retrieves the value for the attribute accessLevelUpdate.
<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 AuditEntry> Collection<T>	getAudit() Retrieves a set containing all the elements for the reference audit.
<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.
Date	getCreatedAt() Retrieves the value for the attribute createdAt.
Set<String>	getCreatedBy()
<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()
XRI	getIdentity() Retrieves the value for the derived attribute identity.
Date	getModifiedAt() Retrieves the value for the attribute modifiedAt.
Set<String>	getModifiedBy()
List<String>	getOwner()
<T extends PrincipalGroup> List<T>	getOwningGroup() Retrieves the Collection of objects referenced by owningGroup.
User	getOwningUser() Retrieves the value for the reference owningUser.
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.
<T extends org.openmdx.compatibility.view1.cci2.View> Collection<T>	getView() Retrieves a set containing all the elements for the reference view.
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()
<T extends ImportResult> T	importItem(byte[] item, String itemMimeType, String itemName, short locale)
Boolean	isStoreSettingsOnLogoff()
static UserHome.Identity	newIdentity(org.openmdx.base.cci2.Segment.Identity segment, boolean principalIdIsPersistent, String principalId)
protected org.w3c.jdo2.AbstractObject.Slice	newSlice(int index)
protected List<String>	openmdxjdoGetClass() Retrieve the model class
protected String	openmdxjdoGetObjectId() Retrieve the object's JDO identity key
static CloseableCollection<UserHome>	openmdxjdoGetObjectsByParent(Segment segment) Navigate through an object's composite association
protected int	openmdxjdoGetSize(int field)
protected <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E>	openmdxjdoGetSlices()
protected void	openmdxjdoSetSize(int field, int size)
<T extends org.openmdx.base.cci2.Void> T	refreshItems()
<T extends ModifySecureObjectResult> T	removeAllOwningGroup(short mode)
<T extends ModifySecureObjectResult> T	removeOwningGroup(PrincipalGroup group, short mode)
<T extends org.openmdx.base.cci2.Void> T	sendAlert(String description, short importance, String name, org.openmdx.base.cci2.BasicObject reference, String toUsers)
<T extends ModifySecureObjectResult> T	setAccessLevel(short accessLevelBrowse, short accessLevelDelete, short accessLevelUpdate, short mode)
void	setAccessLevelBrowse(short accessLevelBrowse) Sets a new value for the attribute accessLevelBrowse.
void	setAccessLevelDelete(short accessLevelDelete) Sets a new value for the attribute accessLevelDelete.
void	setAccessLevelUpdate(short accessLevelUpdate) Sets a new value for the attribute accessLevelUpdate.
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.
<T extends ModifySecureObjectResult> T	setOwningUser(short mode, User user)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
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 class org.w3c.jdo2.AbstractObject

openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement

Methods inherited from class org.oasisopen.jdo2.Identifiable

openmdxjdoGetIdentity, openmdxjdoGetIdentity, openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet, openmdxjdoNewObjectId, openmdxjdoNewObjectId

Methods inherited from class java.lang.Object

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

Field Detail

CLASS

public static final List<String> CLASS

Define the model class org::opencrx::kernel::home1::UserHome

BASE_CLASS

public static final List<String> BASE_CLASS

Define this class as base class

See Also:

UserHome.CLASS

Constructor Detail

UserHome

public UserHome()

Method Detail

openmdxjdoGetObjectId

protected String openmdxjdoGetObjectId()

Retrieve the object's JDO identity key

Specified by:

openmdxjdoGetObjectId in class org.oasisopen.jdo2.Identifiable

Returns:

the value of the object's JDO identity key

openmdxjdoGetSlices

protected final <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E> openmdxjdoGetSlices()

Overrides:

openmdxjdoGetSlices in class org.w3c.jdo2.AbstractObject

getAccessLevelDelete

public short getAccessLevelDelete()

Retrieves the value for the attribute accessLevelDelete.

Specified by:

getAccessLevelDelete in interface SecureObject

Returns:

The non-null value for attribute accessLevelDelete.

setAccessLevelDelete

public void setAccessLevelDelete(short accessLevelDelete)

Sets a new value for the attribute accessLevelDelete.

Specified by:

setAccessLevelDelete in interface SecureObject

Parameters:

accessLevelDelete - The non-null new value for attribute accessLevelDelete.

getFavoriteChart0MimeType

public final String getFavoriteChart0MimeType()

Specified by:

getFavoriteChart0MimeType in interface UserHome

Returns:

The possibly null value for attribute favoriteChart0MimeType.

getAccessHistory

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

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

Specified by:

getAccessHistory in interface UserHome

Returns:

A set containing all the elements for this reference.

getEmailAccount

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

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

Specified by:

getEmailAccount in interface UserHome

Returns:

A set containing all the elements for this reference.

getFavoriteChart2MimeType

public final String getFavoriteChart2MimeType()

Specified by:

getFavoriteChart2MimeType in interface UserHome

Returns:

The possibly null value for attribute favoriteChart2MimeType.

isStoreSettingsOnLogoff

public final Boolean isStoreSettingsOnLogoff()

Specified by:

isStoreSettingsOnLogoff in interface UserHome

Returns:

The possibly null value for attribute storeSettingsOnLogoff.

setStoreSettingsOnLogoff

public void setStoreSettingsOnLogoff(Boolean storeSettingsOnLogoff)

Sets a new value for the attribute storeSettingsOnLogoff.

Specified by:

setStoreSettingsOnLogoff in interface UserHome

Parameters:

storeSettingsOnLogoff - The possibly null new value for attribute storeSettingsOnLogoff.

getModifiedBy

public final Set<String> getModifiedBy()

Specified by:

getModifiedBy in interface org.openmdx.base.cci2.BasicObject

Returns:

A set containing all elements for this attribute.

getFavoriteChart3Name

public final String getFavoriteChart3Name()

Specified by:

getFavoriteChart3Name in interface UserHome

Returns:

The possibly null value for attribute favoriteChart3Name.

getSettings

public final String getSettings()

Specified by:

getSettings in interface UserHome

Returns:

The possibly null value for attribute settings.

setSettings

public void setSettings(String settings)

Sets a new value for the attribute settings.

Specified by:

setSettings in interface UserHome

Parameters:

settings - The possibly null new value for attribute settings.

getAccessLevelBrowse

public short getAccessLevelBrowse()

Retrieves the value for the attribute accessLevelBrowse.

Specified by:

getAccessLevelBrowse in interface SecureObject

Returns:

The non-null value for attribute accessLevelBrowse.

setAccessLevelBrowse

public void setAccessLevelBrowse(short accessLevelBrowse)

Sets a new value for the attribute accessLevelBrowse.

Specified by:

setAccessLevelBrowse in interface SecureObject

Parameters:

accessLevelBrowse - The non-null new value for attribute accessLevelBrowse.

getWfProcessInstance

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

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

Specified by:

getWfProcessInstance in interface UserHome

Returns:

A set containing all the elements for this reference.

getFavoriteChart0Name

public final String getFavoriteChart0Name()

Specified by:

getFavoriteChart0Name in interface UserHome

Returns:

The possibly null value for attribute favoriteChart0Name.

removeAllOwningGroup

public <T extends ModifySecureObjectResult> T removeAllOwningGroup(short mode)
                                                        throws RefException

Specified by:

removeAllOwningGroup in interface SecureObject

Throws:

RefException

getFavoriteChart1MimeType

public final String getFavoriteChart1MimeType()

Specified by:

getFavoriteChart1MimeType in interface UserHome

Returns:

The possibly null value for attribute favoriteChart1MimeType.

getSendMailSubjectPrefix

public final String getSendMailSubjectPrefix()

Specified by:

getSendMailSubjectPrefix in interface UserHome

Returns:

The possibly null value for attribute sendMailSubjectPrefix.

setSendMailSubjectPrefix

public void setSendMailSubjectPrefix(String sendMailSubjectPrefix)

Sets a new value for the attribute sendMailSubjectPrefix.

Specified by:

setSendMailSubjectPrefix in interface UserHome

Parameters:

sendMailSubjectPrefix - The possibly null new value for attribute sendMailSubjectPrefix.

setOwningUser

public <T extends ModifySecureObjectResult> T setOwningUser(short mode,
                                                            User user)
                                                 throws RefException

Specified by:

setOwningUser in interface SecureObject

Throws:

RefException

getOwningGroup

public <T extends PrincipalGroup> List<T> getOwningGroup()

Retrieves the Collection of objects referenced by owningGroup.

Specified by:

getOwningGroup in interface SecureObject

Returns:

The Collection of referenced objects.

addOwningGroup

public <T extends ModifySecureObjectResult> T addOwningGroup(PrincipalGroup group,
                                                             short mode)
                                                  throws RefException

Specified by:

addOwningGroup in interface SecureObject

Throws:

RefException

getAlert

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

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

Specified by:

getAlert in interface UserHome

Returns:

A set containing all the elements for this reference.

getFavoriteChart0Description

public final String getFavoriteChart0Description()

Specified by:

getFavoriteChart0Description in interface UserHome

Returns:

The possibly null value for attribute favoriteChart0Description.

importItem

public <T extends ImportResult> T importItem(byte[] item,
                                             String itemMimeType,
                                             String itemName,
                                             short locale)
                                  throws RefException

Specified by:

importItem in interface Importer

Throws:

RefException

removeOwningGroup

public <T extends ModifySecureObjectResult> T removeOwningGroup(PrincipalGroup group,
                                                                short mode)
                                                     throws RefException

Specified by:

removeOwningGroup in interface SecureObject

Throws:

RefException

getFavoriteChart2Description

public final String getFavoriteChart2Description()

Specified by:

getFavoriteChart2Description in interface UserHome

Returns:

The possibly null value for attribute favoriteChart2Description.

refreshItems

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

Specified by:

refreshItems in interface UserHome

Throws:

RefException

getChart0

public Chart getChart0()

Retrieves the value for the reference chart0.

Specified by:

getChart0 in interface UserHome

Returns:

The – possibly null – value for this reference.

setChart0

public void setChart0(Chart chart0)

Sets a new value for the reference chart0.

Specified by:

setChart0 in interface UserHome

Parameters:

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

getChart1

public Chart getChart1()

Retrieves the value for the reference chart1.

Specified by:

getChart1 in interface UserHome

Returns:

The – possibly null – value for this reference.

setChart1

public void setChart1(Chart chart1)

Sets a new value for the reference chart1.

Specified by:

setChart1 in interface UserHome

Parameters:

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

getChart2

public Chart getChart2()

Retrieves the value for the reference chart2.

Specified by:

getChart2 in interface UserHome

Returns:

The – possibly null – value for this reference.

setChart2

public void setChart2(Chart chart2)

Sets a new value for the reference chart2.

Specified by:

setChart2 in interface UserHome

Parameters:

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

getCreatedBy

public final Set<String> getCreatedBy()

Specified by:

getCreatedBy in interface org.openmdx.base.cci2.BasicObject

Returns:

A set containing all elements for this attribute.

getChart3

public Chart getChart3()

Retrieves the value for the reference chart3.

Specified by:

getChart3 in interface UserHome

Returns:

The – possibly null – value for this reference.

setChart3

public void setChart3(Chart chart3)

Sets a new value for the reference chart3.

Specified by:

setChart3 in interface UserHome

Parameters:

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

setAccessLevel

public <T extends ModifySecureObjectResult> T setAccessLevel(short accessLevelBrowse,
                                                             short accessLevelDelete,
                                                             short accessLevelUpdate,
                                                             short mode)
                                                  throws RefException

Specified by:

setAccessLevel in interface SecureObject

Throws:

RefException

getAccessGrantedByParent

public org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()

Retrieves the value for the reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The – possibly null – value for this reference.

getFavoriteChart2Name

public final String getFavoriteChart2Name()

Specified by:

getFavoriteChart2Name in interface UserHome

Returns:

The possibly null value for attribute favoriteChart2Name.

getOwner

public final List<String> getOwner()

Specified by:

getOwner in interface SecureObject

Returns:

A list containing all elements for this attribute.

getQuickAccess

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

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

Specified by:

getQuickAccess in interface UserHome

Returns:

A set containing all the elements for this reference.

getWorkWeekName

public final String getWorkWeekName()

Specified by:

getWorkWeekName in interface UserHome

Returns:

The possibly null value for attribute workWeekName.

getWebAccessUrl

public final String getWebAccessUrl()

Specified by:

getWebAccessUrl in interface UserHome

Returns:

The possibly null value for attribute webAccessUrl.

setWebAccessUrl

public void setWebAccessUrl(String webAccessUrl)

Sets a new value for the attribute webAccessUrl.

Specified by:

setWebAccessUrl in interface UserHome

Parameters:

webAccessUrl - The possibly null new value for attribute webAccessUrl.

getView

public <T extends org.openmdx.compatibility.view1.cci2.View> Collection<T> getView()

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

Specified by:

getView in interface org.openmdx.compatibility.view1.cci2.ViewCapable

Returns:

A set containing all the elements for this reference.

changePassword

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

Specified by:

changePassword in interface UserHome

Throws:

RefException

getOwningUser

public User getOwningUser()

Retrieves the value for the reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The – possibly null – value for this reference.

setOwningUser

public void setOwningUser(User owningUser)

Sets a new value for the reference owningUser.

Specified by:

setOwningUser in interface SecureObject

Parameters:

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

executeWorkflow

public <T extends ExecuteWorkflowResult> T executeWorkflow(Date startAt,
                                                           org.openmdx.base.cci2.BasicObject targetObject,
                                                           String targetObjectXri,
                                                           String triggeredByEventId,
                                                           Integer triggeredByEventType,
                                                           Subscription triggeredBySubscription,
                                                           WfProcess workflow)
                                                throws RefException

Specified by:

executeWorkflow in interface WorkflowTarget

Throws:

RefException

getAssignedContract

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

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

Specified by:

getAssignedContract in interface UserHome

Returns:

A set containing all the elements for this reference.

getAssignedActivity

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

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

Specified by:

getAssignedActivity in interface UserHome

Returns:

A set containing all the elements for this reference.

getModifiedAt

public Date getModifiedAt()

Retrieves the value for the attribute modifiedAt.

Specified by:

getModifiedAt in interface org.openmdx.base.cci2.BasicObject

Returns:

The non-null value for attribute modifiedAt.

getPrimaryGroup

public PrincipalGroup getPrimaryGroup()

Retrieves the value for the reference primaryGroup.

Specified by:

getPrimaryGroup in interface UserHome

Returns:

The – possibly null – value for this reference.

setPrimaryGroup

public void setPrimaryGroup(PrincipalGroup primaryGroup)

Sets a new value for the reference primaryGroup.

Specified by:

setPrimaryGroup in interface UserHome

Parameters:

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

getFavoriteChart3MimeType

public final String getFavoriteChart3MimeType()

Specified by:

getFavoriteChart3MimeType in interface UserHome

Returns:

The possibly null value for attribute favoriteChart3MimeType.

getContact

public Contact getContact()

Retrieves the value for the reference contact.

Specified by:

getContact in interface UserHome

Returns:

The – possibly null – value for this reference.

setContact

public void setContact(Contact contact)

Sets a new value for the reference contact.

Specified by:

setContact in interface