oracle.ifs.core.beans

Class ControllerAlert

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SimpleObject

oracle.ifs.beans.TieSimpleObject

oracle.ifs.core.beans.ControllerAlert

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SimpleObjectInterface, Traceable

Direct Known Subclasses:

TieControllerAlert

public class ControllerAlert
extends TieSimpleObject

A ControllerAlert is An object holding the details of a Controller alert.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControllerAlert.AlertCode Enumeration for the various Alert codes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALERTCODE_ATTRIBUTE The name of the Attribute representing The code identify the type of ControllerAlert.
static String	ALERTDATE_ATTRIBUTE The name of the Attribute representing The date this ControllerAlert was placed.
static String	CLASS_NAME The name of the ClassObject representing this class.
static int	CODE_CLEAR The ControllerAlert code that indicates no alert has been posted.
static int	CODE_DISPOSED The ControllerAlert code to declare that a RuntimeState object was disposed without being requested.
static int	CODE_NEWNODE The ControllerAlert code to declare a new node.
static String	CONTROLLERJOB_ATTRIBUTE The name of the Attribute representing The Job that initiated the request, associated with this alert, if any.
static String	INFONUMBER_ATTRIBUTE The name of the Attribute representing Data element for Alert info, for a number.
static String	INFOSTRING_ATTRIBUTE The name of the Attribute representing Data element for Alert info, for a String.
static String	UUID_ATTRIBUTE The name of the Attribute representing the UUID.

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session, NAME_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ControllerAlert(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a ControllerAlert object.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears an instance, by updating all elements to null.
static ControllerAlert	create(LibrarySession session) Creates an empty instance.
ControllerAlert.AlertCode	getAlertCode() Gets the Alert code enum that identifies the type of ControllerAlert.
String	getAlertCodeName() Gets the Alert code name that identifies the type of ControllerAlert.
int	getAlertCodeNumber() Gets the Alert code number that identifies the type of ControllerAlert.
Date	getAlertDate() Gets The date this ControllerAlert was placed.
ControllerJob	getControllerJob() Returns the Job that initiated the request, associated with this alert, if any.
Long	getInfoNumber() Gets Data element for Alert info, for a number.
String	getInfoString() Gets Data element for Alert info, for a String.
String	getUuid() Gets the value of the UUID attribute.
boolean	isAlertActive() Gets whether there is a pending Alert.
void	updateForSimpleAlert(int code) Update the instance, for a simple Alert indicated by the specified Alert code.
void	updateForSimpleAlert(int code, ControllerJob job) Update the instance, for a simple Alert indicated by the specified Alert code, along with an optional associated ControllerJob.

Methods inherited from class oracle.ifs.beans.SimpleObject

free, handleCreate, isValidEventType

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, hasNameAttribute, hasPropertyBundleAttribute, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postCreate, postEvent, postEvent, postFree, postUpdate, preCreate, preFree, prePostAuditEvent, preUpdate, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the ClassObject representing this class.

See Also:

Constant Field Values

UUID_ATTRIBUTE

public static final String UUID_ATTRIBUTE

The name of the Attribute representing the UUID.

See Also:

Constant Field Values

CONTROLLERJOB_ATTRIBUTE

public static final String CONTROLLERJOB_ATTRIBUTE

The name of the Attribute representing The Job that initiated the request, associated with this alert, if any.

See Also:

Constant Field Values

ALERTCODE_ATTRIBUTE

public static final String ALERTCODE_ATTRIBUTE

The name of the Attribute representing The code identify the type of ControllerAlert.

See Also:

Constant Field Values

ALERTDATE_ATTRIBUTE

public static final String ALERTDATE_ATTRIBUTE

The name of the Attribute representing The date this ControllerAlert was placed.

See Also:

Constant Field Values

INFONUMBER_ATTRIBUTE

public static final String INFONUMBER_ATTRIBUTE

The name of the Attribute representing Data element for Alert info, for a number.

See Also:

Constant Field Values

INFOSTRING_ATTRIBUTE

public static final String INFOSTRING_ATTRIBUTE

The name of the Attribute representing Data element for Alert info, for a String.

See Also:

Constant Field Values

CODE_CLEAR

public static final int CODE_CLEAR

The ControllerAlert code that indicates no alert has been posted.

See Also:

Constant Field Values

(Published)

CODE_NEWNODE

public static final int CODE_NEWNODE

The ControllerAlert code to declare a new node.

See Also:

Constant Field Values

(Published)

CODE_DISPOSED

public static final int CODE_DISPOSED

The ControllerAlert code to declare that a RuntimeState object was disposed without being requested.

See Also:

Constant Field Values

(Published)

Constructor Detail

ControllerAlert

protected ControllerAlert(LibrarySession session,
                          Long id,
                          Long classId,
                          S_LibraryObjectData data)
                   throws IfsException

Construct a ControllerAlert object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

Method Detail

getUuid

public String getUuid()
               throws IfsException

Gets the value of the UUID attribute.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getControllerJob

public ControllerJob getControllerJob()
                               throws IfsException

Returns the Job that initiated the request, associated with this alert, if any.

Returns null if there was no associated ControllerJob.

Returns:

the ControllerJob that initiated the Request

Throws:

IfsException - if operation fails

(Published)

getAlertCodeNumber

public int getAlertCodeNumber()
                       throws IfsException

Gets the Alert code number that identifies the type of ControllerAlert.

Returns:

the numberic value of the Alert code

Throws:

IfsException - if the operation fails

getAlertCode

public ControllerAlert.AlertCode getAlertCode()
                                       throws IfsException

Gets the Alert code enum that identifies the type of ControllerAlert.

Returns:

the Alert code enum

Throws:

IfsException - if the operation fails

getAlertCodeName

public String getAlertCodeName()
                        throws IfsException

Gets the Alert code name that identifies the type of ControllerAlert.

Returns:

the Alert code name

Throws:

IfsException - if the operation fails

getAlertDate

public Date getAlertDate()
                  throws IfsException

Gets The date this ControllerAlert was placed.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

isAlertActive

public boolean isAlertActive()
                      throws IfsException

Gets whether there is a pending Alert.

Returns:

true if there is a pending alert

Throws:

IfsException - if the operation fails

getInfoNumber

public Long getInfoNumber()
                   throws IfsException

Gets Data element for Alert info, for a number.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getInfoString

public String getInfoString()
                     throws IfsException

Gets Data element for Alert info, for a String.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

create

public static ControllerAlert create(LibrarySession session)
                              throws IfsException

Creates an empty instance.

Parameters:

session - session context

Returns:

the newly created instance

Throws:

IfsException - if the operation fails

clear

public void clear()
           throws IfsException

Clears an instance, by updating all elements to null.

Throws:

IfsException - if the operation fails

updateForSimpleAlert

public void updateForSimpleAlert(int code)
                          throws IfsException

Update the instance, for a simple Alert indicated by the specified Alert code.

Parameters:

code - the Alert code

Throws:

IfsException - if the operation fails

updateForSimpleAlert

public void updateForSimpleAlert(int code,
                                 ControllerJob job)
                          throws IfsException

Update the instance, for a simple Alert indicated by the specified Alert code, along with an optional associated ControllerJob.

Parameters:

code - the Alert code

job - the associated ControllerJob, if any

Throws:

IfsException - if the operation fails