org.opencrx.kernel.home1.cci2
Interface Alert

All Superinterfaces:
Auditee, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, SecureObject, org.openmdx.compatibility.view1.cci2.ViewCapable, WorkflowTarget
All Known Subinterfaces:
Alert
All Known Implementing Classes:
Alert

public interface Alert
extends Auditee, SecureObject, WorkflowTarget, org.openmdx.base.cci2.BasicObject

Class Alert


Nested Class Summary
static interface Alert.Identity
          Object Identity
 
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.
 org.openmdx.compatibility.view1.cci2.ViewCapable getReference()
          Retrieves the value for the reference reference.
<T extends org.openmdx.base.cci2.Void>
T
markAsAccepted()
           
<T extends org.openmdx.base.cci2.Void>
T
markAsRead()
           
 void setAlertState(short alertState)
          Sets a new value for the attribute alertState.
 void setDescription(String description)
          Sets a new value for the attribute description.
 void setImportance(short importance)
          Sets a new value for the attribute importance.
 void setName(String name)
          Sets a new value for the attribute name.
 void setReference(org.openmdx.compatibility.view1.cci2.ViewCapable reference)
          Sets a new value for the reference reference.
 void setUserHome(UserHome userHome)
          Sets a new value for the reference userHome.
 void setUserHome(UserHome userHome, boolean idIsPersistent, String id)
          Set the object's composite association org:opencrx:kernel:home1:UserHomeContainsAlert.
 
Methods inherited from interface org.opencrx.kernel.base.cci2.Auditee
getAudit
 
Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject
addOwningGroup, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser
 
Methods inherited from interface org.opencrx.kernel.base.cci2.WorkflowTarget
executeWorkflow
 
Methods inherited from interface org.openmdx.base.cci2.BasicObject
getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy
 
Methods inherited from interface org.openmdx.base.cci2.ExtentCapable
getIdentity
 
Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable
getView
 

Method Detail

getAlertState

short getAlertState()
Retrieves the value for the attribute alertState.

Returns:
The non-null value for attribute alertState.

setAlertState

void setAlertState(short alertState)
Sets a new value for the attribute alertState.

Parameters:
alertState - The non-null new value for attribute alertState.

getDescription

String getDescription()
Returns:
The possibly null value for attribute description.

setDescription

void setDescription(String description)
Sets a new value for the attribute description.

Parameters:
description - The possibly null new value for attribute description.

getImportance

short getImportance()
Retrieves the value for the attribute importance.

Returns:
The non-null value for attribute importance.

setImportance

void setImportance(short importance)
Sets a new value for the attribute importance.

Parameters:
importance - The non-null new value for attribute importance.

markAsAccepted

<T extends org.openmdx.base.cci2.Void> T markAsAccepted()
                                                    throws RefException
Throws:
RefException

markAsRead

<T extends org.openmdx.base.cci2.Void> T markAsRead()
                                                throws RefException
Throws:
RefException

getName

String getName()
Retrieves the value for the attribute name.

Returns:
The non-null value for attribute name.

setName

void setName(String name)
Sets a new value for the attribute name.

Parameters:
name - The non-null new value for attribute name.

getReference

org.openmdx.compatibility.view1.cci2.ViewCapable getReference()
Retrieves the value for the reference reference.

Returns:
The – possibly null – value for this reference.

setReference

void setReference(org.openmdx.compatibility.view1.cci2.ViewCapable reference)
Sets a new value for the reference reference.

Parameters:
reference - The non-null new value for this reference.

setUserHome

void setUserHome(UserHome userHome)
Sets a new value for the reference userHome.

Parameters:
userHome - The non-null new value for this reference.

setUserHome

void setUserHome(UserHome userHome,
                 boolean idIsPersistent,
                 String id)
Set the object's composite association org:opencrx:kernel:home1:UserHomeContainsAlert.

Parameters:
userHome - The non-null new value for this object's composite owner.
idIsPersistent - Defines whether the id is persistent.
id - The non-null new value for this object's qualifier.


This software is published under the BSD license. Copyright © 2003-2007, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.