org.opencrx.kernel.home1.jmi1
Interface UserHome

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

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

Class UserHome


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.opencrx.kernel.home1.cci2.UserHome
UserHome.Identity
 
Method Summary
 void addAccessHistory(boolean idIsPersistent, String id, AccessHistory accessHistory)
          Adds the specified element to the set of the values for the reference accessHistory.
 void addAlert(boolean idIsPersistent, String id, Alert alert)
          Adds the specified element to the set of the values for the reference alert.
 void addCalendarProfile(boolean idIsPersistent, String id, CalendarProfile calendarProfile)
          Adds the specified element to the set of the values for the reference calendarProfile.
 void addEmailAccount(boolean idIsPersistent, String id, EmailAccount eMailAccount)
          Adds the specified element to the set of the values for the reference eMailAccount.
 void addExportProfile(boolean idIsPersistent, String id, ExportProfile exportProfile)
          Adds the specified element to the set of the values for the reference exportProfile.
 void addObjectFinder(boolean idIsPersistent, String id, ObjectFinder objectFinder)
          Adds the specified element to the set of the values for the reference objectFinder.
 void addQuickAccess(boolean idIsPersistent, String id, QuickAccess quickAccess)
          Adds the specified element to the set of the values for the reference quickAccess.
 void addSubscription(boolean idIsPersistent, String id, Subscription subscription)
          Adds the specified element to the set of the values for the reference subscription.
 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.
 CalendarProfile getCalendarProfile(boolean idIsPersistent, String id)
          Retrieves the value for the reference calendarProfile for the specified qualifier attribute value.
<T extends CalendarProfile>
List<T>
getCalendarProfile(CalendarProfileQuery query)
          Retrieves the value for the reference calendarProfile for the specified query.
 CalendarProfile getCalendarProfile(String id)
          Retrieves the value for the reference calendarProfile for the specified qualifier attribute value.
 Chart getChart(boolean idIsPersistent, String id)
          Retrieves the value for the reference chart for the specified qualifier attribute value.
<T extends Chart>
List<T>
getChart(ChartQuery query)
          Retrieves the value for the reference chart for the specified query.
 Chart getChart(String id)
          Retrieves the value for the reference chart for the specified qualifier attribute value.
 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.
 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.
 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 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 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, getCalendarProfile, getChart, getEmailAccount, getExportProfile, getFavoriteChart0, getFavoriteChart0Description, getFavoriteChart0MimeType, getFavoriteChart0Name, getFavoriteChart1, getFavoriteChart1Description, getFavoriteChart1MimeType, getFavoriteChart1Name, getFavoriteChart2, getFavoriteChart2Description, getFavoriteChart2MimeType, getFavoriteChart2Name, getFavoriteChart3, getFavoriteChart3Description, getFavoriteChart3MimeType, getFavoriteChart3Name, getObjectFinder, getQuickAccess, getSendMailSubjectPrefix, getSettings, getSubscription, getWebAccessUrl, getWfProcessInstance, getWorkWeek, getWorkWeekMimeType, getWorkWeekName, 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, 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, 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.ContextCapable
getContext
 
Methods inherited from interface org.openmdx.base.cci2.ExtentCapable
getIdentity
 
Methods inherited from interface org.openmdx.compatibility.view1.jmi1.ViewCapable
getView, getView, getView
 
Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable
getView
 
Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0
refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect
 
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.

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.

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

getCalendarProfile

<T extends CalendarProfile> List<T> getCalendarProfile(CalendarProfileQuery query)
Retrieves the value for the reference calendarProfile 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.

getCalendarProfile

CalendarProfile getCalendarProfile(boolean idIsPersistent,
                                   String id)
Retrieves the value for the reference calendarProfile 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

getCalendarProfile

CalendarProfile getCalendarProfile(String id)
Retrieves the value for the reference calendarProfile for the specified qualifier attribute value.

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

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

addCalendarProfile

void addCalendarProfile(boolean idIsPersistent,
                        String id,
                        CalendarProfile calendarProfile)
Adds the specified element to the set of the values for the reference calendarProfile.

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.
calendarProfile - The element to be appended.

changePassword

ChangePasswordResult changePassword(ChangePasswordParams in)

getChart

<T extends Chart> List<T> getChart(ChartQuery 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

Chart 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

Chart 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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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


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