Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.opencrx.kernel.home1.jmi1
Interface UserHome

All Superinterfaces:
AlertSender, Auditee, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, Importer, RefBaseObject, RefFeatured, RefObject, SecureObject, UserHome, org.openmdx.compatibility.view1.cci2.ViewCapable, WorkflowTarget
public interface UserHome
extends UserHome, AlertSender, Auditee, Importer, SecureObject, WorkflowTarget, org.openmdx.base.jmi1.BasicObject

Class UserHome

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.opencrx.kernel.home1.cci2.UserHome
UserHome.Identity
 
Method Summary
 void addAccessHistory(AccessHistory newValue)
          
 void addAccessHistory(String id, AccessHistory newValue)
          
 void addAlert(Alert newValue)
          
 void addAlert(String id, Alert newValue)
          
 void addEMailAccount(EmailAccount newValue)
          
 void addEMailAccount(String id, EmailAccount newValue)
          
 void addOwningGroup(int index, PrincipalGroup newValue)
          
 void addOwningGroup(PrincipalGroup newValue)
          
 void addQuickAccess(QuickAccess newValue)
          
 void addQuickAccess(String id, QuickAccess newValue)
          
 void addSubscription(String id, Subscription newValue)
          
 void addSubscription(Subscription newValue)
          
<T extends ChangePasswordResult>
T
changePassword(ChangePasswordParams params)
           
 org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()
          Retrieves the value for the reference accessGrantedByParent.
<T extends AccessHistory>
List<T>
getAccessHistory(AccessHistoryQuery query)
          Retrieves the value for the reference accessHistory for the specified query.
<T extends Alert>
List<T>
getAlert(AlertQuery query)
          Retrieves the value for the reference alert for the specified query.
<T extends Activity>
List<T>
getAssignedActivity(ActivityQuery query)
          Retrieves the value for the reference assignedActivity for the specified query.
<T extends AbstractContract>
List<T>
getAssignedContract(AbstractContractQuery query)
          Retrieves the value for the reference assignedContract for the specified query.
<T extends AuditEntry>
List<T>
getAudit(AuditEntryQuery query)
          Retrieves the value for the reference audit for the specified query.
<T extends Chart>
List<T>
getChart(ChartQuery query)
          Retrieves the value for the reference chart for the specified query.
 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>
List<T>
getEmailAccount(EmailAccountQuery query)
          Retrieves the value for the reference eMailAccount for the specified query.
 User getOwningUser()
          Retrieves the value for the reference owningUser.
 PrincipalGroup getPrimaryGroup()
          Retrieves the value for the reference primaryGroup.
<T extends QuickAccess>
List<T>
getQuickAccess(QuickAccessQuery query)
          Retrieves the value for the reference quickAccess for the specified query.
<T extends Subscription>
List<T>
getSubscription(SubscriptionQuery query)
          Retrieves the value for the reference subscription for the specified query.
<T extends org.openmdx.compatibility.view1.cci2.View>
List<T>
getView(org.openmdx.compatibility.view1.cci2.ViewQuery query)
          Retrieves the value for the reference view for the specified query.
<T extends WfProcessInstance>
List<T>
getWfProcessInstance(WfProcessInstanceQuery query)
          Retrieves the value for the reference wfProcessInstance for the specified query.
<T extends org.openmdx.base.cci2.Void>
T
refreshItems(org.openmdx.base.cci2.Void params)
           
 void removeAccessHistory(String id)
          
 void removeAlert(String id)
          
 void removeChart0()
          Removes the value for the optional reference chart0.
 void removeChart1()
          Removes the value for the optional reference chart1.
 void removeChart2()
          Removes the value for the optional reference chart2.
 void removeChart3()
          Removes the value for the optional reference chart3.
 void removeContact()
          Removes the value for the optional reference contact.
 void removeEMailAccount(String id)
          
 void removeOwningGroup(int index)
          
 void removeOwningUser()
          Removes the value for the optional reference owningUser.
 void removePrimaryGroup()
          Removes the value for the optional reference primaryGroup.
 void removeQuickAccess(String id)
          
 void removeSubscription(String id)
          
 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 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.
 
Methods inherited from interface org.opencrx.kernel.home1.cci2.UserHome
changePassword, getAccessHistory, getAlert, getAssignedActivity, getAssignedContract, getChart, getEmailAccount, getFavoriteChart0, getFavoriteChart0Description, getFavoriteChart0MimeType, getFavoriteChart0Name, getFavoriteChart1, getFavoriteChart1Description, getFavoriteChart1MimeType, getFavoriteChart1Name, getFavoriteChart2, getFavoriteChart2Description, getFavoriteChart2MimeType, getFavoriteChart2Name, getFavoriteChart3, getFavoriteChart3Description, getFavoriteChart3MimeType, getFavoriteChart3Name, getQuickAccess, getSendMailSubjectPrefix, getSettings, getSubscription, getWebAccessUrl, getWfProcessInstance, getWorkWeek, getWorkWeekMimeType, getWorkWeekName, isStoreSettingsOnLogoff, refreshItems, setSendMailSubjectPrefix, setSettings, setStoreSettingsOnLogoff, setWebAccessUrl
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.AlertSender
sendAlert
 
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.jmi1.Importer
importItem
 
Methods inherited from interface org.opencrx.kernel.base.cci2.Importer
importItem
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.SecureObject
addOwningGroup, getOwner, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setOwningUser
 
Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject
addOwningGroup, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.WorkflowTarget
executeWorkflow
 
Methods inherited from interface org.opencrx.kernel.base.cci2.WorkflowTarget
executeWorkflow
 
Methods inherited from interface org.openmdx.base.jmi1.BasicObject
getCreatedBy, getModifiedBy
 
Methods inherited from interface org.openmdx.base.cci2.BasicObject
getCreatedAt, getModifiedAt
 
Methods inherited from interface org.openmdx.base.cci2.ExtentCapable
getIdentity
 
Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable
getView
 
Methods inherited from interface javax.jmi.reflect.RefObject
refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite
 
Methods inherited from interface javax.jmi.reflect.RefFeatured
refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue
 
Methods inherited from interface javax.jmi.reflect.RefBaseObject
equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints
 

Method Detail

getAudit

<T extends AuditEntry> List<T> getAudit(AuditEntryQuery query)
Retrieves the value for the reference audit for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

getAccessGrantedByParent

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.

addOwningGroup

void addOwningGroup(int index,
                    PrincipalGroup newValue)

Parameters:
index - The qualifier attribute value that qualifies the reference to get the element to be appended.
newValue - The element to be appended.

addOwningGroup

void addOwningGroup(PrincipalGroup newValue)

Parameters:
newValue - The element to be appended.

removeOwningGroup

void removeOwningGroup(int index)

getOwningUser

User getOwningUser()
Retrieves the value for the reference owningUser.

Specified by:
getOwningUser in interface SecureObject
Returns:
The – possibly null – value for this reference.

setOwningUser

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.

removeOwningUser

void removeOwningUser()
Removes the value for the optional reference owningUser.

getAccessHistory

<T extends AccessHistory> List<T> getAccessHistory(AccessHistoryQuery query)
Retrieves the value for the reference accessHistory for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

addAccessHistory

void addAccessHistory(String id,
                      AccessHistory newValue)

Parameters:
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
newValue - The element to be appended.

addAccessHistory

void addAccessHistory(AccessHistory newValue)

Parameters:
newValue - The element to be appended.

removeAccessHistory

void removeAccessHistory(String id)

getAlert

<T extends Alert> List<T> getAlert(AlertQuery query)
Retrieves the value for the reference alert for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

addAlert

void addAlert(String id,
              Alert newValue)

Parameters:
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
newValue - The element to be appended.

addAlert

void addAlert(Alert newValue)

Parameters:
newValue - The element to be appended.

removeAlert

void removeAlert(String id)

getAssignedActivity

<T extends Activity> List<T> getAssignedActivity(ActivityQuery query)
Retrieves the value for the reference assignedActivity for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

getAssignedContract

<T extends AbstractContract> List<T> getAssignedContract(AbstractContractQuery query)
Retrieves the value for the reference assignedContract for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

changePassword

<T extends ChangePasswordResult> T changePassword(ChangePasswordParams params)
                                              throws RefException
Throws:
RefException

getChart

<T extends Chart> List<T> getChart(ChartQuery query)
Retrieves the value for the reference chart for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

getChart0

Chart getChart0()
Retrieves the value for the reference chart0.

Specified by:
getChart0 in interface UserHome
Returns:
The – possibly null – value for this reference.

setChart0

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.

removeChart0

void removeChart0()
Removes the value for the optional reference chart0.

getChart1

Chart getChart1()
Retrieves the value for the reference chart1.

Specified by:
getChart1 in interface UserHome
Returns:
The – possibly null – value for this reference.

setChart1

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.

removeChart1

void removeChart1()
Removes the value for the optional reference chart1.

getChart2

Chart getChart2()
Retrieves the value for the reference chart2.

Specified by:
getChart2 in interface UserHome
Returns:
The – possibly null – value for this reference.

setChart2

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.

removeChart2

void removeChart2()
Removes the value for the optional reference chart2.

getChart3

Chart getChart3()
Retrieves the value for the reference chart3.

Specified by:
getChart3 in interface UserHome
Returns:
The – possibly null – value for this reference.

setChart3

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.

removeChart3

void removeChart3()
Removes the value for the optional reference chart3.

getContact

Contact getContact()
Retrieves the value for the reference contact.

Specified by:
getContact in interface UserHome
Returns:
The – possibly null – value for this reference.

setContact

void setContact(Contact contact)
Sets a new value for the reference contact.

Specified by:
setContact in interface UserHome
Parameters:
contact - The non-null new value for this reference.

removeContact

void removeContact()
Removes the value for the optional reference contact.

getEmailAccount

<T extends EmailAccount> List<T> getEmailAccount(EmailAccountQuery query)
Retrieves the value for the reference eMailAccount for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

addEMailAccount

void addEMailAccount(String id,
                     EmailAccount newValue)

Parameters:
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
newValue - The element to be appended.

addEMailAccount

void addEMailAccount(EmailAccount newValue)

Parameters:
newValue - The element to be appended.

removeEMailAccount

void removeEMailAccount(String id)

getPrimaryGroup

PrincipalGroup getPrimaryGroup()
Retrieves the value for the reference primaryGroup.

Specified by:
getPrimaryGroup in interface UserHome
Returns:
The – possibly null – value for this reference.

setPrimaryGroup

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.

removePrimaryGroup

void removePrimaryGroup()
Removes the value for the optional reference primaryGroup.

getQuickAccess

<T extends QuickAccess> List<T> getQuickAccess(QuickAccessQuery query)
Retrieves the value for the reference quickAccess for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

addQuickAccess

void addQuickAccess(String id,
                    QuickAccess newValue)

Parameters:
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
newValue - The element to be appended.

addQuickAccess

void addQuickAccess(QuickAccess newValue)

Parameters:
newValue - The element to be appended.

removeQuickAccess

void removeQuickAccess(String id)

refreshItems

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

getSubscription

<T extends Subscription> List<T> getSubscription(SubscriptionQuery query)
Retrieves the value for the reference subscription for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

addSubscription

void addSubscription(String id,
                     Subscription newValue)

Parameters:
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
newValue - The element to be appended.

addSubscription

void addSubscription(Subscription newValue)

Parameters:
newValue - The element to be appended.

removeSubscription

void removeSubscription(String id)

getWfProcessInstance

<T extends WfProcessInstance> List<T> getWfProcessInstance(WfProcessInstanceQuery query)
Retrieves the value for the reference wfProcessInstance for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

getView

<T extends org.openmdx.compatibility.view1.cci2.View> List<T> getView(org.openmdx.compatibility.view1.cci2.ViewQuery query)
Retrieves the value for the reference view for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

setSegment

void setSegment(Segment segment)
Sets a new value for the reference segment.

Specified by:
setSegment in interface UserHome
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.

Specified by:
setSegment in interface UserHome
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.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
This software is published under the BSD license. Copyright © 2003-2007, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.