oracle.ifs.core.beans

Class ControllerRequest

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SimpleObject

oracle.ifs.beans.TieSimpleObject

oracle.ifs.core.beans.ControllerRequest

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SimpleObjectInterface, Traceable

Direct Known Subclasses:

TieControllerRequest

public class ControllerRequest
extends TieSimpleObject

A ControllerRequest is An object holding the details of a Controller request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControllerRequest.RequestCode Enumeration for the various request 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_CLEAR The ControllerRequest code that indicates no request is in progress.
static int	CODE_DISPOSE The ControllerRequest code to dispose an object.
static int	CODE_PING The ControllerRequest code to Ping an object, asking for a simple Ack reply.
static int	CODE_RECONFIGURE The ControllerRequest code to apply configuration overrides to an object.
static int	CODE_RELOADITEM The ControllerRequest code to reload one of an object's managed items.
static int	CODE_RESTART The ControllerRequest code to Restart an object.
static int	CODE_RESUME The ControllerRequest code to Resume an object after it was subsequently Suspended.
static int	CODE_START The ControllerRequest code to Start an object after it was subsequently stopped.
static int	CODE_STARTNEW The ControllerRequest code to Start an object for the first time, also known as "Load and Start" for Servers.
static int	CODE_STOP The ControllerRequest code to Stop an object after it was subsequently stopped.
static int	CODE_SUSPEND The ControllerRequest code to Suspend an object taht is running.
static String	CONTROLLERJOB_ATTRIBUTE The name of the Attribute representing The Job that initiated the request.
static String	INFONUMBER_ATTRIBUTE The name of the Attribute representing Data element for request info, for a number.
static String	INFOSTRING_ATTRIBUTE The name of the Attribute representing Data element for request info, for a String.
static String	REQUESTCODE_ATTRIBUTE The name of the Attribute representing The code identify the type of ControllerRequest.
static String	REQUESTDATE_ATTRIBUTE The name of the Attribute representing The date this ControllerRequest was placed.
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	ControllerRequest(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a ControllerRequest object.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this instance, by updating all elements to null.
static ControllerRequest	create(LibrarySession session) Creates an empty instance.
ControllerJob	getControllerJob() Returns the ControllerJob that initiated the Request.
Long	getInfoNumber() Gets Data element for request info, for a number.
String	getInfoString() Gets Data element for request info, for a String.
ControllerRequest.RequestCode	getRequestCode() Gets the request code enum that identifies the type of ControllerRequest.
String	getRequestCodeName() Gets the request code name that identifies the type of ControllerRequest.
int	getRequestCodeNumber() Gets the request code number that identifies the type of ControllerRequest.
Date	getRequestDate() Gets The date this ControllerRequest was placed.
String	getUuid() Gets the value of the UUID attribute.
boolean	isRequestActive() Gets whether there is a pending Request.
static String	lookupRequestCodeName(int codeNum) Get the Request code name that corresponds to the specified Request code number.
static Integer	lookupRequestCodeNumber(String codeName) Get the Request code number that corresponds to the specified Request code name.
void	updateForSimpleJob(ControllerJob job) Update the instance, for a simple Request indicated by the specified Request code.
void	updateForSimpleRequest(int code, ControllerJob job) Update the instance, for a simple Request indicated by the specified Request code.

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.

See Also:

Constant Field Values

REQUESTCODE_ATTRIBUTE

public static final String REQUESTCODE_ATTRIBUTE

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

See Also:

Constant Field Values

REQUESTDATE_ATTRIBUTE

public static final String REQUESTDATE_ATTRIBUTE

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

See Also:

Constant Field Values

INFONUMBER_ATTRIBUTE

public static final String INFONUMBER_ATTRIBUTE

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

See Also:

Constant Field Values

CODE_CLEAR

public static final int CODE_CLEAR

The ControllerRequest code that indicates no request is in progress.

See Also:

Constant Field Values

(Published)

CODE_STARTNEW

public static final int CODE_STARTNEW

The ControllerRequest code to Start an object for the first time, also known as "Load and Start" for Servers.

See Also:

Constant Field Values

(Published)

CODE_START

public static final int CODE_START

The ControllerRequest code to Start an object after it was subsequently stopped.

See Also:

Constant Field Values

(Published)

CODE_STOP

public static final int CODE_STOP

The ControllerRequest code to Stop an object after it was subsequently stopped.

See Also:

Constant Field Values

(Published)

CODE_RESTART

public static final int CODE_RESTART

The ControllerRequest code to Restart an object.

See Also:

Constant Field Values

(Published)

CODE_SUSPEND

public static final int CODE_SUSPEND

The ControllerRequest code to Suspend an object taht is running.

See Also:

Constant Field Values

(Published)

CODE_RESUME

public static final int CODE_RESUME

The ControllerRequest code to Resume an object after it was subsequently Suspended.

See Also:

Constant Field Values

(Published)

CODE_RECONFIGURE

public static final int CODE_RECONFIGURE

The ControllerRequest code to apply configuration overrides to an object.

See Also:

Constant Field Values

(Published)

CODE_PING

public static final int CODE_PING

The ControllerRequest code to Ping an object, asking for a simple Ack reply.

See Also:

Constant Field Values

(Published)

CODE_DISPOSE

public static final int CODE_DISPOSE

The ControllerRequest code to dispose an object.

See Also:

Constant Field Values

(Published)

CODE_RELOADITEM

public static final int CODE_RELOADITEM

The ControllerRequest code to reload one of an object's managed items.

See Also:

Constant Field Values

(Published)

Constructor Detail

ControllerRequest

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

Construct a ControllerRequest 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 ControllerJob that initiated the Request.

Returns null if there was no associated ControllerJob.

Returns:

the ControllerJob that initiated the Request

Throws:

IfsException - if operation fails

(Published)

getRequestCodeNumber

public int getRequestCodeNumber()
                         throws IfsException

Gets the request code number that identifies the type of ControllerRequest.

Returns:

the numberic value of the request code

Throws:

IfsException - if the operation fails

getRequestCode

public ControllerRequest.RequestCode getRequestCode()
                                             throws IfsException

Gets the request code enum that identifies the type of ControllerRequest.

Returns:

the request code enum

Throws:

IfsException - if the operation fails

getRequestCodeName

public String getRequestCodeName()
                          throws IfsException

Gets the request code name that identifies the type of ControllerRequest.

Returns:

the request code name

Throws:

IfsException - if the operation fails

lookupRequestCodeNumber

public static Integer lookupRequestCodeNumber(String codeName)
                                       throws IfsException

Get the Request code number that corresponds to the specified Request code name.

Parameters:

codeName - the Request code name

Returns:

the Request code number

Throws:

IfsException - if the operation fails

lookupRequestCodeName

public static String lookupRequestCodeName(int codeNum)
                                    throws IfsException

Get the Request code name that corresponds to the specified Request code number.

Parameters:

codeNum - the Request code number

Returns:

the Request code name

Throws:

IfsException - if the operation fails

getRequestDate

public Date getRequestDate()
                    throws IfsException

Gets The date this ControllerRequest was placed.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

isRequestActive

public boolean isRequestActive()
                        throws IfsException

Gets whether there is a pending Request.

Returns:

true if there is a pending request

Throws:

IfsException - if the operation fails

getInfoNumber

public Long getInfoNumber()
                   throws IfsException

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

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

create

public static ControllerRequest 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

updateForSimpleRequest

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

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

Parameters:

code - the Request code

job - the associated ControllerJob (optional)

Throws:

IfsException - if the operation fails

updateForSimpleJob

public void updateForSimpleJob(ControllerJob job)
                        throws IfsException

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

Parameters:

code - the Request code

Throws:

IfsException - if the operation fails