org.opencrx.kernel.home1.cci2.UserHome Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.home1.cci2;
/**
* Class {@code UserHome}
*
* isFrozenisFrozenisFrozenisFrozenisFrozenisFrozenisFrozen
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:35.533978369Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface UserHome
extends org.opencrx.kernel.activity1.cci2.ActivitiesSource,
org.opencrx.kernel.base.cci2.AlertSender,
org.opencrx.kernel.base.cci2.Auditee,
org.opencrx.kernel.base.cci2.Importer,
org.opencrx.kernel.base.cci2.SecureObject,
org.opencrx.kernel.base.cci2.WorkflowTarget,
org.openmdx.base.cci2.BasicObject{
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code accessHistory}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeContainsAccessHistory.AccessHistory getAccessHistory(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code alert}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeContainsAlert.Alert getAlert(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code assignedActivity}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeHasAssignedActivity.AssignedActivity getAssignedActivity(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code assignedContract}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeHasAssignedContract.AssignedContract getAssignedContract(
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.home1.cci2.ChangePasswordResult changePassword(
org.opencrx.kernel.home1.cci2.ChangePasswordParams in
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code chart}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeContainsChart.Chart getChart(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code contact}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.opencrx.kernel.account1.cci2.Contact getContact(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code contact}.
* @param contact The new—possibly {@code null}—value for this reference.
*/
public void setContact(
org.opencrx.kernel.account1.cci2.Contact contact
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code eMailAccount}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeContainsEMailAccount.EMailAccount getEMailAccount(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code objectFinder}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeContainsObjectFinder.ObjectFinder getObjectFinder(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code primaryGroup}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.opencrx.security.realm1.cci2.PrincipalGroup getPrimaryGroup(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code primaryGroup}.
* @param primaryGroup The new—possibly {@code null}—value for this reference.
*/
public void setPrimaryGroup(
org.opencrx.security.realm1.cci2.PrincipalGroup primaryGroup
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code propertySet}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeContainsProperty.PropertySet getPropertySet(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code quickAccess}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeContainsQuickAccess.QuickAccess getQuickAccess(
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.openmdx.base.cci2.Void refreshItems(
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.openmdx.base.cci2.Void requestPasswordReset(
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.home1.cci2.SearchResult searchAdvanced(
org.opencrx.kernel.home1.cci2.SearchAdvancedParams in
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.home1.cci2.SearchResult searchBasic(
org.opencrx.kernel.home1.cci2.SearchBasicParams in
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code sendMailSubjectPrefix}.
* @return The possibly null value for attribute {@code sendMailSubjectPrefix}.
*/
public java.lang.String getSendMailSubjectPrefix(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code sendMailSubjectPrefix}.
* @param sendMailSubjectPrefix The possibly null new value for attribute {@code sendMailSubjectPrefix}.
*/
public void setSendMailSubjectPrefix(
java.lang.String sendMailSubjectPrefix
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code settings}.
* @return The possibly null value for attribute {@code settings}.
*/
public java.lang.String getSettings(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code settings}.
* @param settings The possibly null new value for attribute {@code settings}.
*/
public void setSettings(
java.lang.String settings
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code storeSettingsOnLogoff}.
* @return The possibly null value for attribute {@code storeSettingsOnLogoff}.
*/
public java.lang.Boolean isStoreSettingsOnLogoff(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code storeSettingsOnLogoff}.
* @param storeSettingsOnLogoff The possibly null new value for attribute {@code storeSettingsOnLogoff}.
*/
public void setStoreSettingsOnLogoff(
java.lang.Boolean storeSettingsOnLogoff
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code subscription}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeContainsSubscription.Subscription getSubscription(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code syncProfile}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeContainsSyncProfile.SyncProfile getSyncProfile(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code timer}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeContainsTimer.Timer getTimer(
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code webAccessUrl}.
* @return The possibly null value for attribute {@code webAccessUrl}.
*/
public java.lang.String getWebAccessUrl(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code webAccessUrl}.
* @param webAccessUrl The possibly null new value for attribute {@code webAccessUrl}.
*/
public void setWebAccessUrl(
java.lang.String webAccessUrl
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code wfProcessInstance}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeContainsWfProcessInstance.WfProcessInstance getWfProcessInstance(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code workList}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.home1.cci2.UserHomeContainsWorkList.WorkList getWorkList(
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// Instance/Containment
// ----------------------------------------------------------------------------
/**
* Object Identity
*/
public interface Identity extends org.oasisopen.cci2.Identity {
/**
* Retrieve the {@code Segment}'s identity
* @return the parent object's identity
*/
public org.openmdx.base.cci2.Segment.Identity getSegment();
/**
* Tells whether the {@code principalId} value is persistent or reassignable.
* @return {@code PERSISTENT} or {@code REASSIGNABLE}
*/
public org.oasisopen.cci2.QualifierType getPrincipalIdType();
/**
* The {@code principalId} value
* @return the {@code principalId} value
*/
public java.lang.String getPrincipalId();
}
}