org.opencrx.kernel.home1.cci
Interface Alert

All Superinterfaces:

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

All Known Implementing Classes:

AlertImpl

public interface Alert
extends Auditee, SecureObject, WorkflowTarget, BasicObject

Method Summary

short	getAlertState() Retrieves the value for the attribute alertState.
String	getDescription()
short	getImportance() Retrieves the value for the attribute importance.
String	getName() Retrieves the value for the attribute name.
ViewCapable	getReference() Retrieves the value for the optional reference reference.
Void	markAsAccepted()
Void	markAsAccepted(Void params)
Void	markAsRead()
Void	markAsRead(Void params)
void	removeReference() Removes the value for the optional reference reference.
void	setAlertState(short newValue) Sets a new value for the attribute alertState.
void	setDescription(String newValue) Sets a new value for the attribute description.
void	setImportance(short newValue) Sets a new value for the attribute importance.
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.Auditee

getAudit, getAudit, getAudit, getAudit

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

getAlertState

short getAlertState()

Retrieves the value for the attribute alertState.

Returns:

The non-null value for attribute alertState.

Throws:

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

setAlertState

void setAlertState(short newValue)

Sets a new value for the attribute alertState.

Parameters:

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

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.

getImportance

short getImportance()

Retrieves the value for the attribute importance.

Returns:

The non-null value for attribute importance.

Throws:

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

setImportance

void setImportance(short newValue)

Sets a new value for the attribute importance.

Parameters:

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

Throws:

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

markAsAccepted

Void markAsAccepted(Void params)
                    throws RefException

Throws:

RefException

markAsAccepted

Void markAsAccepted()
                    throws RefException

Throws:

RefException

markAsRead

Void markAsRead(Void params)
                throws RefException

Throws:

RefException

markAsRead

Void markAsRead()
                throws RefException

Throws:

RefException

getName

String getName()

Retrieves the value for the attribute name.

Returns:

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