org.opencrx.kernel.home1.cci
Interface QuickAccess

All Superinterfaces:

BasicObject, ContextCapable, ExtentCapable, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, ViewCapable

All Known Implementing Classes:

QuickAccessImpl

public interface QuickAccess
extends SecureObject, BasicObject

Method Summary

String	getActionName()
List	getActionParam()
String	getActionParam(int index)
short	getActionType() Retrieves the value for the attribute actionType.
String	getDescription()
String	getIconKey()
String	getName()
ViewCapable	getReference() Retrieves the value for the optional reference reference.
void	removeReference() Removes the value for the optional reference reference.
void	setActionName(String newValue) Sets a new value for the attribute actionName.
void	setActionParam(List newValue)
void	setActionParam(String[] newValue)
void	setActionType(short newValue) Sets a new value for the attribute actionType.
void	setDescription(String newValue) Sets a new value for the attribute description.
void	setIconKey(String newValue) Sets a new value for the attribute iconKey.
void	setName(String newValue) Sets a new value for the attribute name.
void	setReference(ViewCapable newValue) Sets a new value for the reference reference.

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.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

getActionName

String getActionName()

Returns:

The possibly null value for attribute actionName.

Throws:

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

setActionName

void setActionName(String newValue)

Sets a new value for the attribute actionName.

Parameters:

newValue - The possibly null new value for attribute actionName.

Throws:

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

getActionParam

List getActionParam()

Returns:

A list containing all elements for this attribute.

Throws:

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

getActionParam

String getActionParam(int index)

Parameters:

index - The index of the element to return.

Returns:

The element at the specified position in the list of all values for this attribute.

Throws:

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

setActionParam

void setActionParam(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

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

setActionParam

void setActionParam(String[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

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

getActionType

short getActionType()

Retrieves the value for the attribute actionType.

Returns:

The non-null value for attribute actionType.

Throws:

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

setActionType

void setActionType(short newValue)

Sets a new value for the attribute actionType.

Parameters:

newValue - The non-null new value for attribute actionType.

Throws:

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

getDescription

String getDescription()

Returns:

The possibly null value for attribute description.

Throws:

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

setDescription

void setDescription(String newValue)

Sets a new value for the attribute description.

Parameters:

newValue - The possibly null new value for attribute description.

Throws:

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

getIconKey

String getIconKey()

Returns:

The possibly null value for attribute iconKey.

Throws:

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

setIconKey

void setIconKey(String newValue)

Sets a new value for the attribute iconKey.

Parameters:

newValue - The possibly null new value for attribute iconKey.

Throws:

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

getName

String getName()

Returns:

The possibly null value for attribute name.

Throws:

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

setName

void setName(String newValue)

Sets a new value for the attribute name.

Parameters:

newValue - The possibly null new value for attribute name.

Throws:

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

getReference

ViewCapable getReference()

Retrieves the value for the optional reference reference.

Returns:

The possibly null value for this reference.

Throws:

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

setReference

void setReference(ViewCapable newValue)

Sets a new value for the reference reference.

Parameters:

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

Throws:

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

removeReference

void removeReference()

Removes the value for the optional reference reference.

Throws:

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