org.opencrx.kernel.home1.cci
Interface UserHome

All Superinterfaces:

AlertSender, Auditee, BasicObject, ContextCapable, ExtentCapable, Importer, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, ViewCapable, WorkflowTarget

All Known Implementing Classes:

UserHomeImpl

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

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	addQuickAccess(QuickAccess newValue)
void	addQuickAccess(String id, QuickAccess newValue)
void	addSubscription(String id, Subscription newValue)
void	addSubscription(Subscription newValue)
ChangePasswordResult	changePassword(ChangePasswordParams params)
ChangePasswordResult	changePassword(String newPassword, String newPasswordVerification, String oldPassword)
Collection	getAccessHistory() Retrieves a collection containing all the elements for the reference accessHistory.
List	getAccessHistory(AccessHistoryFilter filter) Retrieves the value for the reference accessHistory for the specified filter.
List	getAccessHistory(AccessHistoryQuery query) Retrieves the value for the reference accessHistory for the specified query.
AccessHistory	getAccessHistory(String id) Retrieves the value for the reference accessHistory for the specified qualifier attribute value.
Collection	getAlert() Retrieves a collection containing all the elements for the reference alert.
List	getAlert(AlertFilter filter) Retrieves the value for the reference alert for the specified filter.
List	getAlert(AlertQuery query) Retrieves the value for the reference alert for the specified query.
Alert	getAlert(String id) Retrieves the value for the reference alert for the specified qualifier attribute value.
Collection	getAssignedActivity() Retrieves a collection containing all the elements for the reference assignedActivity.
List	getAssignedActivity(ActivityFilter filter) Retrieves the value for the reference assignedActivity for the specified filter.
List	getAssignedActivity(ActivityQuery query) Retrieves the value for the reference assignedActivity for the specified query.
Activity	getAssignedActivity(String id) Retrieves the value for the reference assignedActivity for the specified qualifier attribute value.
Collection	getAssignedContract() Retrieves a collection containing all the elements for the reference assignedContract.
List	getAssignedContract(AbstractContractFilter filter) Retrieves the value for the reference assignedContract for the specified filter.
List	getAssignedContract(AbstractContractQuery query) Retrieves the value for the reference assignedContract for the specified query.
AbstractContract	getAssignedContract(String id) Retrieves the value for the reference assignedContract for the specified qualifier attribute value.
Collection	getChart() Retrieves a collection containing all the elements for the reference chart.
List	getChart(ChartFilter filter) Retrieves the value for the reference chart for the specified filter.
List	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 optional reference chart0.
Chart	getChart1() Retrieves the value for the optional reference chart1.
Chart	getChart2() Retrieves the value for the optional reference chart2.
Chart	getChart3() Retrieves the value for the optional reference chart3.
Contact	getContact() Retrieves the value for the optional reference contact.
Collection	getEMailAccount() Retrieves a collection containing all the elements for the reference eMailAccount.
List	getEMailAccount(EMailAccountFilter filter) Retrieves the value for the reference eMailAccount for the specified filter.
List	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.
byte[]	getFavoriteChart0() Retrieves the value for the attribute favoriteChart0.
String	getFavoriteChart0Description()
String	getFavoriteChart0MimeType()
String	getFavoriteChart0Name()
byte[]	getFavoriteChart1() Retrieves the value for the attribute favoriteChart1.
String	getFavoriteChart1Description()
String	getFavoriteChart1MimeType()
String	getFavoriteChart1Name()
byte[]	getFavoriteChart2() Retrieves the value for the attribute favoriteChart2.
String	getFavoriteChart2Description()
String	getFavoriteChart2MimeType()
String	getFavoriteChart2Name()
byte[]	getFavoriteChart3() Retrieves the value for the attribute favoriteChart3.
String	getFavoriteChart3Description()
String	getFavoriteChart3MimeType()
String	getFavoriteChart3Name()
PrincipalGroup	getPrimaryGroup() Retrieves the value for the optional reference primaryGroup.
Collection	getQuickAccess() Retrieves a collection containing all the elements for the reference quickAccess.
List	getQuickAccess(QuickAccessFilter filter) Retrieves the value for the reference quickAccess for the specified filter.
List	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.
String	getSendMailSubjectPrefix()
String	getSettings()
Collection	getSubscription() Retrieves a collection containing all the elements for the reference subscription.
Subscription	getSubscription(String id) Retrieves the value for the reference subscription for the specified qualifier attribute value.
List	getSubscription(SubscriptionFilter filter) Retrieves the value for the reference subscription for the specified filter.
List	getSubscription(SubscriptionQuery query) Retrieves the value for the reference subscription for the specified query.
String	getWebAccessUrl()
Collection	getWfProcessInstance() Retrieves a collection containing all the elements for the reference wfProcessInstance.
WfProcessInstance	getWfProcessInstance(String id) Retrieves the value for the reference wfProcessInstance for the specified qualifier attribute value.
List	getWfProcessInstance(WfProcessInstanceFilter filter) Retrieves the value for the reference wfProcessInstance for the specified filter.
List	getWfProcessInstance(WfProcessInstanceQuery query) Retrieves the value for the reference wfProcessInstance for the specified query.
byte[]	getWorkWeek() Retrieves the value for the attribute workWeek.
String	getWorkWeekMimeType()
String	getWorkWeekName()
Boolean	isStoreSettingsOnLogoff()
Void	refreshItems()
Void	refreshItems(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	removePrimaryGroup() Removes the value for the optional reference primaryGroup.
void	removeQuickAccess(String id)
void	removeSubscription(String id)
void	setChart0(Chart newValue) Sets a new value for the reference chart0.
void	setChart1(Chart newValue) Sets a new value for the reference chart1.
void	setChart2(Chart newValue) Sets a new value for the reference chart2.
void	setChart3(Chart newValue) Sets a new value for the reference chart3.
void	setContact(Contact newValue) Sets a new value for the reference contact.
void	setPrimaryGroup(PrincipalGroup newValue) Sets a new value for the reference primaryGroup.
void	setSendMailSubjectPrefix(String newValue) Sets a new value for the attribute sendMailSubjectPrefix.
void	setSettings(String newValue) Sets a new value for the attribute settings.
void	setStoreSettingsOnLogoff(Boolean newValue) Sets a new value for the attribute storeSettingsOnLogoff.
void	setWebAccessUrl(String newValue) Sets a new value for the attribute webAccessUrl.

Methods inherited from interface org.opencrx.kernel.base.cci.AlertSender

sendAlert, sendAlert

Methods inherited from interface org.opencrx.kernel.base.cci.Auditee

getAudit, getAudit, getAudit, getAudit

Methods inherited from interface org.opencrx.kernel.base.cci.Importer

importItem, importItem

Methods inherited from interface org.opencrx.kernel.base.cci.SecureObject

addOwningGroup, addOwningGroup, addOwningGroup, addOwningGroup, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwner, getOwningGroup, getOwningGroup, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningUser, setAccessLevel, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.base.cci.WorkflowTarget

executeWorkflow, executeWorkflow

Methods inherited from interface org.openmdx.base.cci.BasicObject

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

Methods inherited from interface org.openmdx.base.cci.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.cci.ViewCapable

getView, getView, getView, 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

AccessHistory getAccessHistory(String id)

Retrieves the value for the reference accessHistory for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAccessHistory

Collection getAccessHistory()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getAccessHistory

List getAccessHistory(AccessHistoryFilter filter)

Retrieves the value for the reference accessHistory for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAccessHistory

List getAccessHistory(AccessHistoryQuery query)

Retrieves the value for the reference accessHistory for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

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.

Throws:

JmiException - If the value cannot be appended for some reason.

addAccessHistory

void addAccessHistory(AccessHistory newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeAccessHistory

void removeAccessHistory(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getAlert

Alert getAlert(String id)

Retrieves the value for the reference alert for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAlert

Collection getAlert()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getAlert

List getAlert(AlertFilter filter)

Retrieves the value for the reference alert for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAlert

List getAlert(AlertQuery query)

Retrieves the value for the reference alert for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

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.

Throws:

JmiException - If the value cannot be appended for some reason.

addAlert

void addAlert(Alert newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeAlert

void removeAlert(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getAssignedActivity

Activity getAssignedActivity(String id)

Retrieves the value for the reference assignedActivity for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAssignedActivity

Collection getAssignedActivity()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getAssignedActivity

List getAssignedActivity(ActivityFilter filter)

Retrieves the value for the reference assignedActivity for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAssignedActivity

List getAssignedActivity(ActivityQuery query)

Retrieves the value for the reference assignedActivity for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAssignedContract

AbstractContract getAssignedContract(String id)

Retrieves the value for the reference assignedContract for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAssignedContract

Collection getAssignedContract()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getAssignedContract

List getAssignedContract(AbstractContractFilter filter)

Retrieves the value for the reference assignedContract for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAssignedContract

List getAssignedContract(AbstractContractQuery query)

Retrieves the value for the reference assignedContract for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

changePassword

ChangePasswordResult changePassword(ChangePasswordParams params)
                                    throws RefException

Throws:

RefException

changePassword

ChangePasswordResult changePassword(String newPassword,
                                    String newPasswordVerification,
                                    String oldPassword)
                                    throws RefException

Throws:

RefException

getChart

Chart getChart(String id)

Retrieves the value for the reference chart for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getChart

Collection getChart()

Retrieves a collection containing all the elements for the reference chart.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getChart

List getChart(ChartFilter filter)

Retrieves the value for the reference chart for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getChart

List getChart(ChartQuery query)

Retrieves the value for the reference chart for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getChart0

Chart getChart0()

Retrieves the value for the optional reference chart0.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setChart0

void setChart0(Chart newValue)

Sets a new value for the reference chart0.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.

removeChart0

void removeChart0()

Removes the value for the optional reference chart0.

Throws:

JmiException - If the value cannot be removed for some reason.

getChart1

Chart getChart1()

Retrieves the value for the optional reference chart1.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setChart1

void setChart1(Chart newValue)

Sets a new value for the reference chart1.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.

removeChart1

void removeChart1()

Removes the value for the optional reference chart1.

Throws:

JmiException - If the value cannot be removed for some reason.

getChart2

Chart getChart2()

Retrieves the value for the optional reference chart2.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setChart2

void setChart2(Chart newValue)

Sets a new value for the reference chart2.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.

removeChart2

void removeChart2()

Removes the value for the optional reference chart2.

Throws:

JmiException - If the value cannot be removed for some reason.

getChart3

Chart getChart3()

Retrieves the value for the optional reference chart3.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setChart3

void setChart3(Chart newValue)

Sets a new value for the reference chart3.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.

removeChart3

void removeChart3()

Removes the value for the optional reference chart3.

Throws:

JmiException - If the value cannot be removed for some reason.

getContact

Contact getContact()

Retrieves the value for the optional reference contact.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setContact

void setContact(Contact newValue)

Sets a new value for the reference contact.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.

removeContact

void removeContact()

Removes the value for the optional reference contact.

Throws:

JmiException - If the value cannot be removed for some reason.

getEMailAccount

EMailAccount getEMailAccount(String id)

Retrieves the value for the reference eMailAccount for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getEMailAccount

Collection getEMailAccount()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getEMailAccount

List getEMailAccount(EMailAccountFilter filter)

Retrieves the value for the reference eMailAccount for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getEMailAccount

List getEMailAccount(EMailAccountQuery query)

Retrieves the value for the reference eMailAccount for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

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.

Throws:

JmiException - If the value cannot be appended for some reason.

addEMailAccount

void addEMailAccount(EMailAccount newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeEMailAccount

void removeEMailAccount(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getFavoriteChart0

byte[] getFavoriteChart0()

Retrieves the value for the attribute favoriteChart0.

Returns:

The non-null value for attribute favoriteChart0.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart0Description

String getFavoriteChart0Description()

Returns:

The possibly null value for attribute favoriteChart0Description.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart0MimeType

String getFavoriteChart0MimeType()

Returns:

The possibly null value for attribute favoriteChart0MimeType.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart0Name

String getFavoriteChart0Name()

Returns:

The possibly null value for attribute favoriteChart0Name.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart1

byte[] getFavoriteChart1()

Retrieves the value for the attribute favoriteChart1.

Returns:

The non-null value for attribute favoriteChart1.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart1Description

String getFavoriteChart1Description()

Returns:

The possibly null value for attribute favoriteChart1Description.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart1MimeType

String getFavoriteChart1MimeType()

Returns:

The possibly null value for attribute favoriteChart1MimeType.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart1Name

String getFavoriteChart1Name()

Returns:

The possibly null value for attribute favoriteChart1Name.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart2

byte[] getFavoriteChart2()

Retrieves the value for the attribute favoriteChart2.

Returns:

The non-null value for attribute favoriteChart2.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart2Description

String getFavoriteChart2Description()

Returns:

The possibly null value for attribute favoriteChart2Description.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart2MimeType

String getFavoriteChart2MimeType()

Returns:

The possibly null value for attribute favoriteChart2MimeType.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart2Name

String getFavoriteChart2Name()

Returns:

The possibly null value for attribute favoriteChart2Name.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart3

byte[] getFavoriteChart3()

Retrieves the value for the attribute favoriteChart3.

Returns:

The non-null value for attribute favoriteChart3.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart3Description

String getFavoriteChart3Description()

Returns:

The possibly null value for attribute favoriteChart3Description.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart3MimeType

String getFavoriteChart3MimeType()

Returns:

The possibly null value for attribute favoriteChart3MimeType.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFavoriteChart3Name

String getFavoriteChart3Name()

Returns:

The possibly null value for attribute favoriteChart3Name.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getPrimaryGroup

PrincipalGroup getPrimaryGroup()

Retrieves the value for the optional reference primaryGroup.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setPrimaryGroup

void setPrimaryGroup(PrincipalGroup newValue)

Sets a new value for the reference primaryGroup.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.

removePrimaryGroup

void removePrimaryGroup()

Removes the value for the optional reference primaryGroup.

Throws:

JmiException - If the value cannot be removed for some reason.

getQuickAccess

QuickAccess getQuickAccess(String id)

Retrieves the value for the reference quickAccess for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getQuickAccess

Collection getQuickAccess()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getQuickAccess

List getQuickAccess(QuickAccessFilter filter)

Retrieves the value for the reference quickAccess for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getQuickAccess

List getQuickAccess(QuickAccessQuery query)

Retrieves the value for the reference quickAccess for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

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.

Throws:

JmiException - If the value cannot be appended for some reason.

addQuickAccess

void addQuickAccess(QuickAccess newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeQuickAccess

void removeQuickAccess(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

refreshItems

Void refreshItems(Void params)
                  throws RefException

Throws:

RefException

refreshItems

Void refreshItems()
                  throws RefException

Throws:

RefException

getSendMailSubjectPrefix

String getSendMailSubjectPrefix()

Returns:

The possibly null value for attribute sendMailSubjectPrefix.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setSendMailSubjectPrefix

void setSendMailSubjectPrefix(String newValue)

Sets a new value for the attribute sendMailSubjectPrefix.

Parameters:

newValue - The possibly null new value for attribute sendMailSubjectPrefix.

Throws:

JmiException - If the value cannot be set for some reason.

getSettings

String getSettings()

Returns:

The possibly null value for attribute settings.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setSettings

void setSettings(String newValue)

Sets a new value for the attribute settings.

Parameters:

newValue - The possibly null new value for attribute settings.

Throws:

JmiException - If the value cannot be set for some reason.

isStoreSettingsOnLogoff

Boolean isStoreSettingsOnLogoff()

Returns:

The possibly null value for attribute storeSettingsOnLogoff.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setStoreSettingsOnLogoff

void setStoreSettingsOnLogoff(Boolean newValue)

Sets a new value for the attribute storeSettingsOnLogoff.

Parameters:

newValue - The possibly null new value for attribute storeSettingsOnLogoff.

Throws:

JmiException - If the value cannot be set for some reason.

getSubscription

Subscription getSubscription(String id)

Retrieves the value for the reference subscription for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getSubscription

Collection getSubscription()

Retrieves a collection containing all the elements for the reference subscription.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getSubscription

List getSubscription(SubscriptionFilter filter)

Retrieves the value for the reference subscription for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getSubscription

List getSubscription(SubscriptionQuery query)

Retrieves the value for the reference subscription for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

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.

Throws:

JmiException - If the value cannot be appended for some reason.

addSubscription

void addSubscription(Subscription newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeSubscription

void removeSubscription(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getWebAccessUrl

String getWebAccessUrl()

Returns:

The possibly null value for attribute webAccessUrl.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setWebAccessUrl

void setWebAccessUrl(String newValue)

Sets a new value for the attribute webAccessUrl.

Parameters:

newValue - The possibly null new value for attribute webAccessUrl.

Throws:

JmiException - If the value cannot be set for some reason.

getWfProcessInstance

WfProcessInstance getWfProcessInstance(String id)

Retrieves the value for the reference wfProcessInstance for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getWfProcessInstance

Collection getWfProcessInstance()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getWfProcessInstance

List getWfProcessInstance(WfProcessInstanceFilter filter)

Retrieves the value for the reference wfProcessInstance for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getWfProcessInstance

List getWfProcessInstance(WfProcessInstanceQuery query)

Retrieves the value for the reference wfProcessInstance for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getWorkWeek

byte[] getWorkWeek()

Retrieves the value for the attribute workWeek.

Returns:

The non-null value for attribute workWeek.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getWorkWeekMimeType

String getWorkWeekMimeType()

Returns:

The possibly null value for attribute workWeekMimeType.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getWorkWeekName

String getWorkWeekName()

Returns:

The possibly null value for attribute workWeekName.

Throws:

JmiException - If the value cannot be retrieved for some reason.