org.opencrx.kernel.home1.jmi1
Interface UserHome

All Superinterfaces:
AlertSender, Auditee, BasicObject, ContextCapable, Creatable, ExtentCapable, Importer, Modifiable, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, UserHome, WorkflowTarget

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

Class UserHome

isFrozenisFrozenisFrozenisFrozenisFrozenisFrozenisFrozen


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.opencrx.kernel.home1.cci2.UserHome
UserHome.Identity
 
Method Summary
 void addAccessHistory(AccessHistory accessHistory)
          Adds the specified element to the set of the values for the reference accessHistory using an implementation-specific, reassignable qualifier.
 void addAccessHistory(boolean idIsPersistent, String id, AccessHistory accessHistory)
          Adds the specified element to the set of the values for the reference accessHistory.
 void addAccessHistory(String id, AccessHistory accessHistory)
          Adds the specified element to the set of the values for the reference accessHistory using a reassignable qualifier.
 void addAlert(Alert alert)
          Adds the specified element to the set of the values for the reference alert using an implementation-specific, reassignable qualifier.
 void addAlert(boolean idIsPersistent, String id, Alert alert)
          Adds the specified element to the set of the values for the reference alert.
 void addAlert(String id, Alert alert)
          Adds the specified element to the set of the values for the reference alert using a reassignable qualifier.
 void addChart(boolean idIsPersistent, String id, Media chart)
          Adds the specified element to the set of the values for the reference chart.
 void addChart(Media chart)
          Adds the specified element to the set of the values for the reference chart using an implementation-specific, reassignable qualifier.
 void addChart(String id, Media chart)
          Adds the specified element to the set of the values for the reference chart using a reassignable qualifier.
 void addEMailAccount(boolean idIsPersistent, String id, EMailAccount eMailAccount)
          Adds the specified element to the set of the values for the reference eMailAccount.
 void addEMailAccount(EMailAccount eMailAccount)
          Adds the specified element to the set of the values for the reference eMailAccount using an implementation-specific, reassignable qualifier.
 void addEMailAccount(String id, EMailAccount eMailAccount)
          Adds the specified element to the set of the values for the reference eMailAccount using a reassignable qualifier.
 void addExportProfile(boolean idIsPersistent, String id, ExportProfile exportProfile)
          Adds the specified element to the set of the values for the reference exportProfile.
 void addExportProfile(ExportProfile exportProfile)
          Adds the specified element to the set of the values for the reference exportProfile using an implementation-specific, reassignable qualifier.
 void addExportProfile(String id, ExportProfile exportProfile)
          Adds the specified element to the set of the values for the reference exportProfile using a reassignable qualifier.
 void addObjectFinder(boolean idIsPersistent, String id, ObjectFinder objectFinder)
          Adds the specified element to the set of the values for the reference objectFinder.
 void addObjectFinder(ObjectFinder objectFinder)
          Adds the specified element to the set of the values for the reference objectFinder using an implementation-specific, reassignable qualifier.
 void addObjectFinder(String id, ObjectFinder objectFinder)
          Adds the specified element to the set of the values for the reference objectFinder using a reassignable qualifier.
 void addQuickAccess(boolean idIsPersistent, String id, QuickAccess quickAccess)
          Adds the specified element to the set of the values for the reference quickAccess.
 void addQuickAccess(QuickAccess quickAccess)
          Adds the specified element to the set of the values for the reference quickAccess using an implementation-specific, reassignable qualifier.
 void addQuickAccess(String id, QuickAccess quickAccess)
          Adds the specified element to the set of the values for the reference quickAccess using a reassignable qualifier.
 void addSubscription(boolean idIsPersistent, String id, Subscription subscription)
          Adds the specified element to the set of the values for the reference subscription.
 void addSubscription(String id, Subscription subscription)
          Adds the specified element to the set of the values for the reference subscription using a reassignable qualifier.
 void addSubscription(Subscription subscription)
          Adds the specified element to the set of the values for the reference subscription using an implementation-specific, reassignable qualifier.
 void addSyncProfile(boolean idIsPersistent, String id, SyncProfile syncProfile)
          Adds the specified element to the set of the values for the reference syncProfile.
 void addSyncProfile(String id, SyncProfile syncProfile)
          Adds the specified element to the set of the values for the reference syncProfile using a reassignable qualifier.
 void addSyncProfile(SyncProfile syncProfile)
          Adds the specified element to the set of the values for the reference syncProfile using an implementation-specific, reassignable qualifier.
 void addWfProcessInstance(boolean idIsPersistent, String id, WfProcessInstance wfProcessInstance)
          Adds the specified element to the set of the values for the reference wfProcessInstance.
 void addWfProcessInstance(String id, WfProcessInstance wfProcessInstance)
          Adds the specified element to the set of the values for the reference wfProcessInstance using a reassignable qualifier.
 void addWfProcessInstance(WfProcessInstance wfProcessInstance)
          Adds the specified element to the set of the values for the reference wfProcessInstance using an implementation-specific, reassignable qualifier.
 ChangePasswordResult changePassword(ChangePasswordParams in)
           
<T extends AccessHistory>
List<T>
getAccessHistory(AccessHistoryQuery query)
          Retrieves the value for the reference accessHistory for the specified query.
 AccessHistory getAccessHistory(boolean idIsPersistent, String id)
          Retrieves the value for the reference accessHistory for the specified qualifier attribute value.
 AccessHistory getAccessHistory(String id)
          Retrieves the value for the reference accessHistory for the specified qualifier attribute value.
<T extends Alert>
List<T>
getAlert(AlertQuery query)
          Retrieves the value for the reference alert for the specified query.
 Alert getAlert(boolean idIsPersistent, String id)
          Retrieves the value for the reference alert for the specified qualifier attribute value.
 Alert getAlert(String id)
          Retrieves the value for the reference alert for the specified qualifier attribute value.
<T extends Activity>
List<T>
getAssignedActivity(ActivityQuery query)
          Retrieves the value for the reference assignedActivity for the specified query.
 Activity getAssignedActivity(boolean idIsPersistent, String id)
          Retrieves the value for the reference assignedActivity for the specified qualifier attribute value.
 Activity getAssignedActivity(String id)
          Retrieves the value for the reference assignedActivity for the specified qualifier attribute value.
<T extends AbstractContract>
List<T>
getAssignedContract(AbstractContractQuery query)
          Retrieves the value for the reference assignedContract for the specified query.
 AbstractContract getAssignedContract(boolean idIsPersistent, String id)
          Retrieves the value for the reference assignedContract for the specified qualifier attribute value.
 AbstractContract getAssignedContract(String id)
          Retrieves the value for the reference assignedContract for the specified qualifier attribute value.
 Media getChart(boolean idIsPersistent, String id)
          Retrieves the value for the reference chart for the specified qualifier attribute value.
<T extends Media>
List<T>
getChart(MediaQuery query)
          Retrieves the value for the reference chart for the specified query.
 Media getChart(String id)
          Retrieves the value for the reference chart for the specified qualifier attribute value.
 Contact getContact()
          Retrieves the value for the reference contact.
 EMailAccount getEMailAccount(boolean idIsPersistent, String id)
          Retrieves the value for the reference eMailAccount for the specified qualifier attribute value.
<T extends EMailAccount>
List<T>
getEMailAccount(EMailAccountQuery query)
          Retrieves the value for the reference eMailAccount for the specified query.
 EMailAccount getEMailAccount(String id)
          Retrieves the value for the reference eMailAccount for the specified qualifier attribute value.
 ExportProfile getExportProfile(boolean idIsPersistent, String id)
          Retrieves the value for the reference exportProfile for the specified qualifier attribute value.
<T extends ExportProfile>
List<T>
getExportProfile(ExportProfileQuery query)
          Retrieves the value for the reference exportProfile for the specified query.
 ExportProfile getExportProfile(String id)
          Retrieves the value for the reference exportProfile for the specified qualifier attribute value.
 ObjectFinder getObjectFinder(boolean idIsPersistent, String id)
          Retrieves the value for the reference objectFinder for the specified qualifier attribute value.
<T extends ObjectFinder>
List<T>
getObjectFinder(ObjectFinderQuery query)
          Retrieves the value for the reference objectFinder for the specified query.
 ObjectFinder getObjectFinder(String id)
          Retrieves the value for the reference objectFinder for the specified qualifier attribute value.
 PrincipalGroup getPrimaryGroup()
          Retrieves the value for the reference primaryGroup.
 QuickAccess getQuickAccess(boolean idIsPersistent, String id)
          Retrieves the value for the reference quickAccess for the specified qualifier attribute value.
<T extends QuickAccess>
List<T>
getQuickAccess(QuickAccessQuery query)
          Retrieves the value for the reference quickAccess for the specified query.
 QuickAccess getQuickAccess(String id)
          Retrieves the value for the reference quickAccess for the specified qualifier attribute value.
 Subscription getSubscription(boolean idIsPersistent, String id)
          Retrieves the value for the reference subscription for the specified qualifier attribute value.
 Subscription getSubscription(String id)
          Retrieves the value for the reference subscription for the specified qualifier attribute value.
<T extends Subscription>
List<T>
getSubscription(SubscriptionQuery query)
          Retrieves the value for the reference subscription for the specified query.
 SyncProfile getSyncProfile(boolean idIsPersistent, String id)
          Retrieves the value for the reference syncProfile for the specified qualifier attribute value.
 SyncProfile getSyncProfile(String id)
          Retrieves the value for the reference syncProfile for the specified qualifier attribute value.
<T extends SyncProfile>
List<T>
getSyncProfile(SyncProfileQuery query)
          Retrieves the value for the reference syncProfile for the specified query.
 WfProcessInstance getWfProcessInstance(boolean idIsPersistent, String id)
          Retrieves the value for the reference wfProcessInstance for the specified qualifier attribute value.
 WfProcessInstance getWfProcessInstance(String id)
          Retrieves the value for the reference wfProcessInstance for the specified qualifier attribute value.
<T extends WfProcessInstance>
List<T>
getWfProcessInstance(WfProcessInstanceQuery query)
          Retrieves the value for the reference wfProcessInstance for the specified query.
 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.
 
Methods inherited from interface org.opencrx.kernel.home1.cci2.UserHome
changePassword, getAccessHistory, getAlert, getAssignedActivity, getAssignedContract, getChart, getEMailAccount, getExportProfile, getObjectFinder, getQuickAccess, getSendMailSubjectPrefix, getSettings, getSubscription, getSyncProfile, getWebAccessUrl, getWfProcessInstance, isStoreSettingsOnLogoff, searchAdvanced, searchBasic, 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.jmi1.Auditee
getAudit, getAudit, getAudit
 
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, checkPermissions, getAccessGrantedByParent, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwner, setOwningUser, setOwningUser
 
Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject
addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, 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.Creatable
getCreatedBy
 
Methods inherited from interface org.openmdx.base.cci2.Creatable
getCreatedAt
 
Methods inherited from interface org.openmdx.base.cci2.ExtentCapable
getIdentity
 
Methods inherited from interface org.openmdx.base.jmi1.Modifiable
getModifiedBy
 
Methods inherited from interface org.openmdx.base.cci2.Modifiable
getModifiedAt
 
Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0
refDefaultFetchGroup, refDelegate, refGetPath, refGetValue, refInitialize, refInitialize, refSetValue
 
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

getAccessHistory

<T extends AccessHistory> List<T> getAccessHistory(AccessHistoryQuery query)
Retrieves the value for the reference accessHistory for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

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

getAccessHistory

AccessHistory getAccessHistory(boolean idIsPersistent,
                               String id)
Retrieves the value for the reference accessHistory for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getAccessHistory

AccessHistory getAccessHistory(String id)
Retrieves the value for the reference accessHistory for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getAccessHistory(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addAccessHistory

void addAccessHistory(boolean idIsPersistent,
                      String id,
                      AccessHistory accessHistory)
Adds the specified element to the set of the values for the reference accessHistory.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
accessHistory - The element to be appended.

addAccessHistory

void addAccessHistory(String id,
                      AccessHistory accessHistory)
Adds the specified element to the set of the values for the reference accessHistory using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

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

addAccessHistory

void addAccessHistory(AccessHistory accessHistory)
Adds the specified element to the set of the values for the reference accessHistory using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:
accessHistory - The element to be appended.

getAlert

<T extends Alert> List<T> getAlert(AlertQuery query)
Retrieves the value for the reference alert for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

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

getAlert

Alert getAlert(boolean idIsPersistent,
               String id)
Retrieves the value for the reference alert for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getAlert

Alert getAlert(String id)
Retrieves the value for the reference alert for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getAlert(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addAlert

void addAlert(boolean idIsPersistent,
              String id,
              Alert alert)
Adds the specified element to the set of the values for the reference alert.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
alert - The element to be appended.

addAlert

void addAlert(String id,
              Alert alert)
Adds the specified element to the set of the values for the reference alert using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

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

addAlert

void addAlert(Alert alert)
Adds the specified element to the set of the values for the reference alert using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:
alert - The element to be appended.

getAssignedActivity

<T extends Activity> List<T> getAssignedActivity(ActivityQuery query)
Retrieves the value for the reference assignedActivity for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

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

getAssignedActivity

Activity getAssignedActivity(boolean idIsPersistent,
                             String id)
Retrieves the value for the reference assignedActivity for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getAssignedActivity

Activity getAssignedActivity(String id)
Retrieves the value for the reference assignedActivity for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getAssignedActivity(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getAssignedContract

<T extends AbstractContract> List<T> getAssignedContract(AbstractContractQuery query)
Retrieves the value for the reference assignedContract for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

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

getAssignedContract

AbstractContract getAssignedContract(boolean idIsPersistent,
                                     String id)
Retrieves the value for the reference assignedContract for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getAssignedContract

AbstractContract getAssignedContract(String id)
Retrieves the value for the reference assignedContract for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getAssignedContract(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

changePassword

ChangePasswordResult changePassword(ChangePasswordParams in)

getChart

<T extends Media> List<T> getChart(MediaQuery query)
Retrieves the value for the reference chart for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

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

getChart

Media getChart(boolean idIsPersistent,
               String id)
Retrieves the value for the reference chart for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getChart

Media getChart(String id)
Retrieves the value for the reference chart for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getChart(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addChart

void addChart(boolean idIsPersistent,
              String id,
              Media chart)
Adds the specified element to the set of the values for the reference chart.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
chart - The element to be appended.

addChart

void addChart(String id,
              Media chart)
Adds the specified element to the set of the values for the reference chart using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

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

addChart

void addChart(Media chart)
Adds the specified element to the set of the values for the reference chart using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:
chart - The element to be appended.

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.

getEMailAccount

<T extends EMailAccount> List<T> getEMailAccount(EMailAccountQuery query)
Retrieves the value for the reference eMailAccount for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

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

getEMailAccount

EMailAccount getEMailAccount(boolean idIsPersistent,
                             String id)
Retrieves the value for the reference eMailAccount for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getEMailAccount

EMailAccount getEMailAccount(String id)
Retrieves the value for the reference eMailAccount for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getEMailAccount(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addEMailAccount

void addEMailAccount(boolean idIsPersistent,
                     String id,
                     EMailAccount eMailAccount)
Adds the specified element to the set of the values for the reference eMailAccount.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
eMailAccount - The element to be appended.

addEMailAccount

void addEMailAccount(String id,
                     EMailAccount eMailAccount)
Adds the specified element to the set of the values for the reference eMailAccount using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

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

addEMailAccount

void addEMailAccount(EMailAccount eMailAccount)
Adds the specified element to the set of the values for the reference eMailAccount using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:
eMailAccount - The element to be appended.

getExportProfile

<T extends ExportProfile> List<T> getExportProfile(ExportProfileQuery query)
Retrieves the value for the reference exportProfile for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

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

getExportProfile

ExportProfile getExportProfile(boolean idIsPersistent,
                               String id)
Retrieves the value for the reference exportProfile for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getExportProfile

ExportProfile getExportProfile(String id)
Retrieves the value for the reference exportProfile for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getExportProfile(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addExportProfile

void addExportProfile(boolean idIsPersistent,
                      String id,
                      ExportProfile exportProfile)
Adds the specified element to the set of the values for the reference exportProfile.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
exportProfile - The element to be appended.

addExportProfile

void addExportProfile(String id,
                      ExportProfile exportProfile)
Adds the specified element to the set of the values for the reference exportProfile using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

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

addExportProfile

void addExportProfile(ExportProfile exportProfile)
Adds the specified element to the set of the values for the reference exportProfile using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:
exportProfile - The element to be appended.

getObjectFinder

<T extends ObjectFinder> List<T> getObjectFinder(ObjectFinderQuery query)
Retrieves the value for the reference objectFinder for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

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

getObjectFinder

ObjectFinder getObjectFinder(boolean idIsPersistent,
                             String id)
Retrieves the value for the reference objectFinder for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getObjectFinder

ObjectFinder getObjectFinder(String id)
Retrieves the value for the reference objectFinder for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getObjectFinder(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addObjectFinder

void addObjectFinder(boolean idIsPersistent,
                     String id,
                     ObjectFinder objectFinder)
Adds the specified element to the set of the values for the reference objectFinder.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
objectFinder - The element to be appended.

addObjectFinder

void addObjectFinder(String id,
                     ObjectFinder objectFinder)
Adds the specified element to the set of the values for the reference objectFinder using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

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

addObjectFinder

void addObjectFinder(ObjectFinder objectFinder)
Adds the specified element to the set of the values for the reference objectFinder using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:
objectFinder - The element to be appended.

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.

getQuickAccess

<T extends QuickAccess> List<T> getQuickAccess(QuickAccessQuery query)
Retrieves the value for the reference quickAccess for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

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

getQuickAccess

QuickAccess getQuickAccess(boolean idIsPersistent,
                           String id)
Retrieves the value for the reference quickAccess for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getQuickAccess

QuickAccess getQuickAccess(String id)
Retrieves the value for the reference quickAccess for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getQuickAccess(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addQuickAccess

void addQuickAccess(boolean idIsPersistent,
                    String id,
                    QuickAccess quickAccess)
Adds the specified element to the set of the values for the reference quickAccess.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
quickAccess - The element to be appended.

addQuickAccess

void addQuickAccess(String id,
                    QuickAccess quickAccess)
Adds the specified element to the set of the values for the reference quickAccess using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

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

addQuickAccess

void addQuickAccess(QuickAccess quickAccess)
Adds the specified element to the set of the values for the reference quickAccess using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:
quickAccess - The element to be appended.

refreshItems

Void refreshItems()
Specified by:
refreshItems in interface UserHome

searchAdvanced

SearchResult searchAdvanced(SearchAdvancedParams in)

searchBasic

SearchResult searchBasic(SearchBasicParams in)

getSubscription

<T extends Subscription> List<T> getSubscription(SubscriptionQuery query)
Retrieves the value for the reference subscription for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

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

getSubscription

Subscription getSubscription(boolean idIsPersistent,
                             String id)
Retrieves the value for the reference subscription for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getSubscription

Subscription getSubscription(String id)
Retrieves the value for the reference subscription for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getSubscription(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addSubscription

void addSubscription(boolean idIsPersistent,
                     String id,
                     Subscription subscription)
Adds the specified element to the set of the values for the reference subscription.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
subscription - The element to be appended.

addSubscription

void addSubscription(String id,
                     Subscription subscription)
Adds the specified element to the set of the values for the reference subscription using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

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

addSubscription

void addSubscription(Subscription subscription)
Adds the specified element to the set of the values for the reference subscription using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:
subscription - The element to be appended.

getSyncProfile

<T extends SyncProfile> List<T> getSyncProfile(SyncProfileQuery query)
Retrieves the value for the reference syncProfile for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

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

getSyncProfile

SyncProfile getSyncProfile(boolean idIsPersistent,
                           String id)
Retrieves the value for the reference syncProfile for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getSyncProfile

SyncProfile getSyncProfile(String id)
Retrieves the value for the reference syncProfile for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getSyncProfile(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addSyncProfile

void addSyncProfile(boolean idIsPersistent,
                    String id,
                    SyncProfile syncProfile)
Adds the specified element to the set of the values for the reference syncProfile.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
syncProfile - The element to be appended.

addSyncProfile

void addSyncProfile(String id,
                    SyncProfile syncProfile)
Adds the specified element to the set of the values for the reference syncProfile using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

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

addSyncProfile

void addSyncProfile(SyncProfile syncProfile)
Adds the specified element to the set of the values for the reference syncProfile using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:
syncProfile - The element to be appended.

getWfProcessInstance

<T extends WfProcessInstance> List<T> getWfProcessInstance(WfProcessInstanceQuery query)
Retrieves the value for the reference wfProcessInstance for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

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

getWfProcessInstance

WfProcessInstance getWfProcessInstance(boolean idIsPersistent,
                                       String id)
Retrieves the value for the reference wfProcessInstance for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getWfProcessInstance

WfProcessInstance getWfProcessInstance(String id)
Retrieves the value for the reference wfProcessInstance for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getWfProcessInstance(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addWfProcessInstance

void addWfProcessInstance(boolean idIsPersistent,
                          String id,
                          WfProcessInstance wfProcessInstance)
Adds the specified element to the set of the values for the reference wfProcessInstance.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
wfProcessInstance - The element to be appended.

addWfProcessInstance

void addWfProcessInstance(String id,
                          WfProcessInstance wfProcessInstance)
Adds the specified element to the set of the values for the reference wfProcessInstance using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

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

addWfProcessInstance

void addWfProcessInstance(WfProcessInstance wfProcessInstance)
Adds the specified element to the set of the values for the reference wfProcessInstance using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:
wfProcessInstance - The element to be appended.


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