org.opencrx.kernel.home1.jdo2
Class Alert

java.lang.Object
  org.oasisopen.jdo2.Identifiable
      org.w3c.jdo2.AbstractObject
          org.opencrx.kernel.home1.jdo2.Alert

All Implemented Interfaces:

Serializable, Auditee, SecureObject, WorkflowTarget, Alert, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, org.openmdx.compatibility.view1.cci2.ViewCapable

public class Alert
extends org.w3c.jdo2.AbstractObject
implements Alert

Class Alert

See Also:

Serialized Form

Nested Class Summary

static class	Alert.Identity The object's application identity
static class	Alert.Slice

Nested classes/interfaces inherited from class org.w3c.jdo2.AbstractObject

org.w3c.jdo2.AbstractObject.BLOB, org.w3c.jdo2.AbstractObject.CLOB, org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>

Field Summary

static List<String>	BASE_CLASS Define this class as base class
static List<String>	CLASS Define the model class org::opencrx::kernel::home1::Alert

Constructor Summary

Alert()

Method Summary

<T extends ModifySecureObjectResult> T	addOwningGroup(PrincipalGroup group, short mode)
<T extends ExecuteWorkflowResult> T	executeWorkflow(Date startAt, org.openmdx.base.cci2.BasicObject targetObject, String targetObjectXri, String triggeredByEventId, Integer triggeredByEventType, Subscription triggeredBySubscription, WfProcess workflow)
org.openmdx.base.cci2.BasicObject	getAccessGrantedByParent() Retrieves the value for the reference accessGrantedByParent.
short	getAccessLevelBrowse() Retrieves the value for the attribute accessLevelBrowse.
short	getAccessLevelDelete() Retrieves the value for the attribute accessLevelDelete.
short	getAccessLevelUpdate() Retrieves the value for the attribute accessLevelUpdate.
short	getAlertState() Retrieves the value for the attribute alertState.
<T extends AuditEntry> Collection<T>	getAudit() Retrieves a set containing all the elements for the reference audit.
Date	getCreatedAt() Retrieves the value for the attribute createdAt.
Set<String>	getCreatedBy()
String	getDescription()
XRI	getIdentity() Retrieves the value for the derived attribute identity.
short	getImportance() Retrieves the value for the attribute importance.
Date	getModifiedAt() Retrieves the value for the attribute modifiedAt.
Set<String>	getModifiedBy()
String	getName() Retrieves the value for the attribute name.
List<String>	getOwner()
<T extends PrincipalGroup> List<T>	getOwningGroup() Retrieves the Collection of objects referenced by owningGroup.
User	getOwningUser() Retrieves the value for the reference owningUser.
org.openmdx.compatibility.view1.cci2.ViewCapable	getReference() Retrieves the value for the reference reference.
<T extends org.openmdx.compatibility.view1.cci2.View> Collection<T>	getView() Retrieves a set containing all the elements for the reference view.
<T extends org.openmdx.base.cci2.Void> T	markAsAccepted()
<T extends org.openmdx.base.cci2.Void> T	markAsRead()
static Alert.Identity	newIdentity(UserHome.Identity userHome, boolean idIsPersistent, String id)
protected org.w3c.jdo2.AbstractObject.Slice	newSlice(int index)
protected List<String>	openmdxjdoGetClass() Retrieve the model class
protected String	openmdxjdoGetObjectId() Retrieve the object's JDO identity key
static CloseableCollection<Alert>	openmdxjdoGetObjectsByParent(UserHome userHome) Navigate through an object's composite association
protected int	openmdxjdoGetSize(int field)
protected <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E>	openmdxjdoGetSlices()
protected void	openmdxjdoSetSize(int field, int size)
<T extends ModifySecureObjectResult> T	removeAllOwningGroup(short mode)
<T extends ModifySecureObjectResult> T	removeOwningGroup(PrincipalGroup group, short mode)
<T extends ModifySecureObjectResult> T	setAccessLevel(short accessLevelBrowse, short accessLevelDelete, short accessLevelUpdate, short mode)
void	setAccessLevelBrowse(short accessLevelBrowse) Sets a new value for the attribute accessLevelBrowse.
void	setAccessLevelDelete(short accessLevelDelete) Sets a new value for the attribute accessLevelDelete.
void	setAccessLevelUpdate(short accessLevelUpdate) Sets a new value for the attribute accessLevelUpdate.
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.
<T extends ModifySecureObjectResult> T	setOwningUser(short mode, User user)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
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 class org.w3c.jdo2.AbstractObject

openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement

Methods inherited from class org.oasisopen.jdo2.Identifiable

openmdxjdoGetIdentity, openmdxjdoGetIdentity, openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet, openmdxjdoNewObjectId, openmdxjdoNewObjectId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS

public static final List<String> CLASS

Define the model class org::opencrx::kernel::home1::Alert

BASE_CLASS

public static final List<String> BASE_CLASS

Define this class as base class

See Also:

Alert.CLASS

Constructor Detail

Alert

public Alert()

Method Detail

openmdxjdoGetObjectId

protected String openmdxjdoGetObjectId()

Retrieve the object's JDO identity key

Specified by:

openmdxjdoGetObjectId in class org.oasisopen.jdo2.Identifiable

Returns:

the value of the object's JDO identity key

openmdxjdoGetSlices

protected final <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E> openmdxjdoGetSlices()

Overrides:

openmdxjdoGetSlices in class org.w3c.jdo2.AbstractObject

getAccessLevelDelete

public short getAccessLevelDelete()

Retrieves the value for the attribute accessLevelDelete.

Specified by:

getAccessLevelDelete in interface SecureObject

Returns:

The non-null value for attribute accessLevelDelete.

setAccessLevelDelete

public void setAccessLevelDelete(short accessLevelDelete)

Sets a new value for the attribute accessLevelDelete.

Specified by:

setAccessLevelDelete in interface SecureObject

Parameters:

accessLevelDelete - The non-null new value for attribute accessLevelDelete.

getModifiedAt

public Date getModifiedAt()

Retrieves the value for the attribute modifiedAt.

Specified by:

getModifiedAt in interface org.openmdx.base.cci2.BasicObject

Returns:

The non-null value for attribute modifiedAt.

getModifiedBy

public final Set<String> getModifiedBy()

Specified by:

getModifiedBy in interface org.openmdx.base.cci2.BasicObject

Returns:

A set containing all elements for this attribute.

getAccessLevelBrowse

public short getAccessLevelBrowse()

Retrieves the value for the attribute accessLevelBrowse.

Specified by:

getAccessLevelBrowse in interface SecureObject

Returns:

The non-null value for attribute accessLevelBrowse.

setAccessLevelBrowse

public void setAccessLevelBrowse(short accessLevelBrowse)

Sets a new value for the attribute accessLevelBrowse.

Specified by:

setAccessLevelBrowse in interface SecureObject

Parameters:

accessLevelBrowse - The non-null new value for attribute accessLevelBrowse.

markAsRead

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

Specified by:

markAsRead in interface Alert

Throws:

RefException

getIdentity

public XRI getIdentity()

Retrieves the value for the derived attribute identity.

Specified by:

getIdentity in interface org.openmdx.base.cci2.ExtentCapable

Returns:

The non-null value for the attribute identity

getCreatedAt

public Date getCreatedAt()

Retrieves the value for the attribute createdAt.

Specified by:

getCreatedAt in interface org.openmdx.base.cci2.BasicObject

Returns:

The non-null value for attribute createdAt.

getDescription

public final String getDescription()

Specified by:

getDescription in interface Alert

Returns:

The possibly null value for attribute description.

setDescription

public void setDescription(String description)

Sets a new value for the attribute description.

Specified by:

setDescription in interface Alert

Parameters:

description - The possibly null new value for attribute description.

removeAllOwningGroup

public <T extends ModifySecureObjectResult> T removeAllOwningGroup(short mode)
                                                        throws RefException

Specified by:

removeAllOwningGroup in interface SecureObject

Throws:

RefException

getName

public String getName()

Retrieves the value for the attribute name.

Specified by:

getName in interface Alert

Returns:

The non-null value for attribute name.

setName

public void setName(String name)

Sets a new value for the attribute name.

Specified by:

setName in interface Alert

Parameters:

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

getAlertState

public short getAlertState()

Retrieves the value for the attribute alertState.

Specified by:

getAlertState in interface Alert

Returns:

The non-null value for attribute alertState.

setAlertState

public void setAlertState(short alertState)

Sets a new value for the attribute alertState.

Specified by:

setAlertState in interface Alert

Parameters:

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

setOwningUser

public <T extends ModifySecureObjectResult> T setOwningUser(short mode,
                                                            User user)
                                                 throws RefException

Specified by:

setOwningUser in interface SecureObject

Throws:

RefException

getOwningGroup

public <T extends PrincipalGroup> List<T> getOwningGroup()

Retrieves the Collection of objects referenced by owningGroup.

Specified by:

getOwningGroup in interface SecureObject

Returns:

The Collection of referenced objects.

addOwningGroup

public <T extends ModifySecureObjectResult> T addOwningGroup(PrincipalGroup group,
                                                             short mode)
                                                  throws RefException

Specified by:

addOwningGroup in interface SecureObject

Throws:

RefException

markAsAccepted

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

Specified by:

markAsAccepted in interface Alert

Throws:

RefException

getAudit

public <T extends AuditEntry> Collection<T> getAudit()

Retrieves a set containing all the elements for the reference audit.

Specified by:

getAudit in interface Auditee

Returns:

A set containing all the elements for this reference.

removeOwningGroup

public <T extends ModifySecureObjectResult> T removeOwningGroup(PrincipalGroup group,
                                                                short mode)
                                                     throws RefException

Specified by:

removeOwningGroup in interface SecureObject

Throws:

RefException

getReference

public org.openmdx.compatibility.view1.cci2.ViewCapable getReference()

Retrieves the value for the reference reference.

Specified by:

getReference in interface Alert

Returns:

The – possibly null – value for this reference.

setReference

public void setReference(org.openmdx.compatibility.view1.cci2.ViewCapable reference)

Sets a new value for the reference reference.

Specified by:

setReference in interface Alert

Parameters:

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

getAccessLevelUpdate

public short getAccessLevelUpdate()

Retrieves the value for the attribute accessLevelUpdate.

Specified by:

getAccessLevelUpdate in interface SecureObject

Returns:

The non-null value for attribute accessLevelUpdate.

setAccessLevelUpdate

public void setAccessLevelUpdate(short accessLevelUpdate)

Sets a new value for the attribute accessLevelUpdate.

Specified by:

setAccessLevelUpdate in interface SecureObject

Parameters:

accessLevelUpdate - The non-null new value for attribute accessLevelUpdate.

getImportance

public short getImportance()

Retrieves the value for the attribute importance.

Specified by:

getImportance in interface Alert

Returns:

The non-null value for attribute importance.

setImportance

public void setImportance(short importance)

Sets a new value for the attribute importance.

Specified by:

setImportance in interface Alert

Parameters:

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

getCreatedBy

public final Set<String> getCreatedBy()

Specified by:

getCreatedBy in interface org.openmdx.base.cci2.BasicObject

Returns:

A set containing all elements for this attribute.

getAccessGrantedByParent

public org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()

Retrieves the value for the reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The – possibly null – value for this reference.

setAccessLevel

public <T extends ModifySecureObjectResult> T setAccessLevel(short accessLevelBrowse,
                                                             short accessLevelDelete,
                                                             short accessLevelUpdate,
                                                             short mode)
                                                  throws RefException

Specified by:

setAccessLevel in interface SecureObject

Throws:

RefException

getOwner

public final List<String> getOwner()

Specified by:

getOwner in interface SecureObject

Returns:

A list containing all elements for this attribute.

getView

public <T extends org.openmdx.compatibility.view1.cci2.View> Collection<T> getView()

Retrieves a set containing all the elements for the reference view.

Specified by:

getView in interface org.openmdx.compatibility.view1.cci2.ViewCapable

Returns:

A set containing all the elements for this reference.

getOwningUser

public User getOwningUser()

Retrieves the value for the reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The – possibly null – value for this reference.

setOwningUser

public void setOwningUser(User owningUser)

Sets a new value for the reference owningUser.

Specified by:

setOwningUser in interface SecureObject

Parameters:

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

executeWorkflow

public <T extends ExecuteWorkflowResult> T executeWorkflow(Date startAt,
                                                           org.openmdx.base.cci2.BasicObject targetObject,
                                                           String targetObjectXri,
                                                           String triggeredByEventId,
                                                           Integer triggeredByEventType,
                                                           Subscription triggeredBySubscription,
                                                           WfProcess workflow)
                                                throws RefException

Specified by:

executeWorkflow in interface WorkflowTarget

Throws:

RefException

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)

Overrides:

openmdxjdoGetSize in class org.w3c.jdo2.AbstractObject

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)

Overrides:

openmdxjdoSetSize in class org.w3c.jdo2.AbstractObject

newSlice

protected org.w3c.jdo2.AbstractObject.Slice newSlice(int index)

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()

Retrieve the model class

Returns:

the model class

See Also:

Alert.CLASS

setUserHome

public void setUserHome(UserHome userHome)

Sets a new value for the reference userHome.

Specified by:

setUserHome in interface Alert

Parameters:

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

openmdxjdoGetObjectsByParent

public static CloseableCollection<Alert> openmdxjdoGetObjectsByParent(UserHome userHome)

Navigate through an object's composite association

setUserHome

public void setUserHome(UserHome userHome,
                        boolean idIsPersistent,
                        String id)

Set the object's composite association org:opencrx:kernel:home1:UserHomeContainsAlert.

Specified by:

setUserHome in interface Alert

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.

newIdentity

public static Alert.Identity newIdentity(UserHome.Identity userHome,
                                         boolean idIsPersistent,
                                         String id)