oracle.ifs.core.beans

Class ControllerReply

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SimpleObject

oracle.ifs.beans.TieSimpleObject

oracle.ifs.core.beans.ControllerReply

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SimpleObjectInterface, Traceable

Direct Known Subclasses:

TieControllerReply

public class ControllerReply
extends TieSimpleObject

A ControllerReply is An object holding the details of a Controller reply.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControllerReply.ReplyCode Enumeration for the various Reply codes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static int	CODE_ACKNOWLEDGE The ControllerReply code for a standard acknowledge to the current request.
static int	CODE_CLEAR The ControllerReply code that indicates no reply has been made.
static int	CODE_NONACKNOWLEDGE The ControllerReply code for a standard non-acknowledge to the current request.
static String	CONTROLLERJOB_ATTRIBUTE The name of the Attribute representing The Job that initiated the request associated with this reply.
static String	INFONUMBER_ATTRIBUTE The name of the Attribute representing Data element for reply info, for a number.
static String	INFOSTRING_ATTRIBUTE The name of the Attribute representing Data element for reply info, for a String.
static String	REPLYBEGINDATE_ATTRIBUTE The name of the Attribute representing The date this ControllerReply was received by the Managing Node.
static String	REPLYCODE_ATTRIBUTE The name of the Attribute representing The code identify the type of ControllerReply.
static String	REPLYDATE_ATTRIBUTE The name of the Attribute representing The date this ControllerReply was completed.
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	ControllerReply(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a ControllerReply object.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this instance, by updating all elements to null.
static ControllerReply	create(LibrarySession session) Creates an empty instance.
ControllerJob	getControllerJob() Returns the Job that initiated the request associated with this reply.
Long	getInfoNumber() Gets Data element for reply info, for a number.
String	getInfoString() Gets Data element for reply info, for a String.
Date	getReplyBeginDate() Gets The date this ControllerReply was received by the managing Node.
ControllerReply.ReplyCode	getReplyCode() Gets the Reply code enum that identifies the type of ControllerReply.
String	getReplyCodeName() Gets the Reply code name that identifies the type of ControllerReply.
int	getReplyCodeNumber() Gets the Reply code number that identifies the type of ControllerReply.
Date	getReplyDate() Gets The date this ControllerReply was completed.
String	getUuid() Gets the value of the UUID attribute.
boolean	isReplyActive() Gets whether there is a pending completed Reply.
boolean	isReplyBegun() Gets whether there is the Reply has been received and has begun..
void	updateForSimpleReply(int code, ControllerJob job) Update the instance, for a simple Reply indicated by the specified Reply code.
void	updateReplyBeginDate(ControllerJob job) Update the instance, for to set the reply begin Date.

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

See Also:

Constant Field Values

REPLYCODE_ATTRIBUTE

public static final String REPLYCODE_ATTRIBUTE

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

See Also:

Constant Field Values

REPLYBEGINDATE_ATTRIBUTE

public static final String REPLYBEGINDATE_ATTRIBUTE

The name of the Attribute representing The date this ControllerReply was received by the Managing Node.

See Also:

Constant Field Values

REPLYDATE_ATTRIBUTE

public static final String REPLYDATE_ATTRIBUTE

The name of the Attribute representing The date this ControllerReply was completed.

See Also:

Constant Field Values

INFONUMBER_ATTRIBUTE

public static final String INFONUMBER_ATTRIBUTE

The name of the Attribute representing Data element for reply 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 reply info, for a String.

See Also:

Constant Field Values

CODE_CLEAR

public static final int CODE_CLEAR

The ControllerReply code that indicates no reply has been made.

See Also:

Constant Field Values

(Published)

CODE_ACKNOWLEDGE

public static final int CODE_ACKNOWLEDGE

The ControllerReply code for a standard acknowledge to the current request.

See Also:

Constant Field Values

(Published)

CODE_NONACKNOWLEDGE

public static final int CODE_NONACKNOWLEDGE

The ControllerReply code for a standard non-acknowledge to the current request.

See Also:

Constant Field Values

(Published)

Constructor Detail

ControllerReply

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

Construct a ControllerReply 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 reply.

Returns null if there was no associated ControllerJob.

Returns:

the ControllerJob that initiated the Request

Throws:

IfsException - if operation fails

(Published)

getReplyCodeNumber

public int getReplyCodeNumber()
                       throws IfsException

Gets the Reply code number that identifies the type of ControllerReply.

Returns:

the numberic value of the Reply code

Throws:

IfsException - if the operation fails

getReplyCode

public ControllerReply.ReplyCode getReplyCode()
                                       throws IfsException

Gets the Reply code enum that identifies the type of ControllerReply.

Returns:

the Reply code enum

Throws:

IfsException - if the operation fails

getReplyCodeName

public String getReplyCodeName()
                        throws IfsException

Gets the Reply code name that identifies the type of ControllerReply.

Returns:

the Reply code name

Throws:

IfsException - if the operation fails

getReplyBeginDate

public Date getReplyBeginDate()
                       throws IfsException

Gets The date this ControllerReply was received by the managing Node.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getReplyDate

public Date getReplyDate()
                  throws IfsException

Gets The date this ControllerReply was completed.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

isReplyBegun

public boolean isReplyBegun()
                     throws IfsException

Gets whether there is the Reply has been received and has begun..

Returns:

true if the reply has begun

Throws:

IfsException - if the operation fails

isReplyActive

public boolean isReplyActive()
                      throws IfsException

Gets whether there is a pending completed Reply.

Returns:

true if there is a pending completed Reply

Throws:

IfsException - if the operation fails

getInfoNumber

public Long getInfoNumber()
                   throws IfsException

Gets Data element for reply 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 reply info, for a String.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

create

public static ControllerReply 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 this instance, by updating all elements to null.

Throws:

IfsException - if the operation fails

updateReplyBeginDate

public void updateReplyBeginDate(ControllerJob job)
                          throws IfsException

Update the instance, for to set the reply begin Date.

Parameters:

job - the ControllerJob, if any

Throws:

IfsException - if the operation fails

updateForSimpleReply

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

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

Parameters:

code - the Reply code

job - the associated ControllerJob (optional)

Throws:

IfsException - if the operation fails