org.opencrx.kernel.home1.cci2.QuickAccess Maven / Gradle / Ivy
The newest version!
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.home1.cci2;
/**
* Class {@code QuickAccess}
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:35.582013881Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface QuickAccess
extends org.opencrx.kernel.base.cci2.SecureObject,
org.openmdx.base.cci2.BasicObject{
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code actionName}.
* @return The possibly null value for attribute {@code actionName}.
*/
public java.lang.String getActionName(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code actionName}.
* @param actionName The possibly null new value for attribute {@code actionName}.
*/
public void setActionName(
java.lang.String actionName
);
// ----------------------------------------------------------------------------
// Instance/AttributeGetList
// ----------------------------------------------------------------------------
/**
* Retrieves a list containing all the elements for the attribute {@code actionParam}.
* @return A list containing all elements for this attribute.
*/
public java.util.List getActionParam(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSetList
// ----------------------------------------------------------------------------
/**
* Clears {@code actionParam} and adds the given value(s).
*
* This method is equivalent to
* list.clear();
* for(java.lang.String e : actionParam){
* list.add(e);
* }
*
* @param actionParam value(s) to be added to {@code actionParam}
*/
public void setActionParam(
java.lang.String... actionParam
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code actionType}.
* @return The non-null value for attribute {@code actionType}.
*/
public short getActionType(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code actionType}.
* @param actionType The non-{@code null} new value for attribute {@code actionType}.
*/
public void setActionType(
short actionType
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code description}.
* @return The possibly null value for attribute {@code description}.
*/
public java.lang.String getDescription(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code description}.
* @param description The possibly null new value for attribute {@code description}.
*/
public void setDescription(
java.lang.String description
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code iconKey}.
* @return The possibly null value for attribute {@code iconKey}.
*/
public java.lang.String getIconKey(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code iconKey}.
* @param iconKey The possibly null new value for attribute {@code iconKey}.
*/
public void setIconKey(
java.lang.String iconKey
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code name}.
* @return The possibly null value for attribute {@code name}.
*/
public java.lang.String getName(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code name}.
* @param name The possibly null new value for attribute {@code name}.
*/
public void setName(
java.lang.String name
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code quickAccessStatus}.
* @return The non-null value for attribute {@code quickAccessStatus}.
*/
public short getQuickAccessStatus(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code quickAccessStatus}.
* @param quickAccessStatus The non-{@code null} new value for attribute {@code quickAccessStatus}.
*/
public void setQuickAccessStatus(
short quickAccessStatus
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code reference}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.openmdx.base.cci2.ContextCapable getReference(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code reference}.
* @param reference The new—possibly {@code null}—value for this reference.
*/
public void setReference(
org.openmdx.base.cci2.ContextCapable reference
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code referencedObjectType}.
* @return The possibly null value for attribute {@code referencedObjectType}.
*/
public java.lang.String getReferencedObjectType(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code referencedObjectType}.
* @param referencedObjectType The possibly null new value for attribute {@code referencedObjectType}.
*/
public void setReferencedObjectType(
java.lang.String referencedObjectType
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// Instance/Containment
// ----------------------------------------------------------------------------
/**
* Object Identity
*/
public interface Identity extends org.oasisopen.cci2.Identity {
/**
* Retrieve the {@code UserHome}'s identity
* @return the parent object's identity
*/
public org.opencrx.kernel.home1.cci2.UserHome.Identity getUserHome();
/**
* Tells whether the {@code id} value is persistent or reassignable.
* @return {@code PERSISTENT} or {@code REASSIGNABLE}
*/
public org.oasisopen.cci2.QualifierType getIdType();
/**
* The {@code id} value
* @return the {@code id} value
*/
public java.lang.String getId();
}
}