oracle.ifs.core.beans

Class ControllerPlan

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SimpleObject

oracle.ifs.beans.TieSimpleObject

oracle.ifs.core.beans.ControllerPlan

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SimpleObjectInterface, Traceable

Direct Known Subclasses:

TieControllerPlan

public class ControllerPlan
extends TieSimpleObject

A ControllerPlan holds the details of the plan the Controller is asked to execute.

Author:

Dave Long

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	DESCRIPTION_ATTRIBUTE The name of the Attribute representing The description of the ControllerPlan.
static String	NAME_ATTRIBUTE The name of the Attribute representing The name of the ControllerPlan.
static String	NODECAPABILITYBYPOSITION_ATTRIBUTE The name of the Attribute representing The capability of Node required for each of the expected Nodes, arranged in the array by Node position.
static String	NODECOUNT_ATTRIBUTE The name of the Attribute representing The number of Nodes expected by the plan.
static String	NODELABELBYPOSITION_ATTRIBUTE The name of the Attribute representing the labels used to identify an assigned Node by its position.
static String	PLANTABLELIST_ATTRIBUTE The name of the Attribute representing Reference to object holding the details describing the plan.
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, PROPERTYBUNDLE_ATTRIBUTE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addAssignment(AttributeValueTable assignment) Adds an assignment to the map.
static ControllerPlan[]	findAll(LibrarySession session) Returns the set of defined ControllerPlans.
static ControllerPlan	findByName(LibrarySession session, String name) Returns the a ControllerPlan matching the specified name.
List<AttributeValueTable>	getAssignments() Gets the set of assignment definitions for this plan.
String	getDescription() Gets The description of the ControllerPlan.
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySession session) Returns the LibraryObjectLookupCache used by find ControllerPlan instances by name.
String[]	getNodeCapabilityByPosition() Gets the capability of Node required for each of the expected Nodes, arranged in the array by Node position.
int	getNodeCount() Gets the number of Nodes expected by the plan.
String[]	getNodeLabelByPosition() Gets the labels used to identify an assigned Node by its position.
SimplePropertyTable	getObjectPropertyTable() Gets the SimplePropertyTable representing this object's metadata.
SimplePropertyTableList	getPlanTableList() Gets Reference to object holding the details describing the plan.
String	getRecoveryPeriod() Gets the recovery time period, which is the duration to wait before returning back to a "fully started" state after one or more assigned Nodes are no longer assigned.
String	getStartupPeriod() Gets the startup time period, which is the duration to wait while assigning Nodes before automatically changing to a "fully started" state.
String	getUuid() Gets the value of the UUID attribute.
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.
boolean	isEveryAssignmentFinal() Gets an indicator of whether every assignment entry should be considered as being defined as "final", meaning the classification hierarchy will not be checked further if no Node is defined at the lowest defined level.
protected void	postCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the creation of a object.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
void	setEveryAssignmentFinal(boolean val) Sets an indicator of whether every assignment entry should be considered as being defined as "final", meaning the classification hierarchy will not be checked further if no Node is defined at the lowest defined level.
void	setRecoveryPeriod(String val) Sets the recovery time period, which is the duration to wait before returning back to a "fully started" state after one or more assigned Nodes are no longer assigned.
void	setStartupPeriod(String val) Sets the startup time period, which is the duration to wait while assigning Nodes before automatically changing to a "fully started" state.

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, hasPropertyBundleAttribute, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, postUpdate, preCreate, 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

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

The name of the Attribute representing The name of the ControllerPlan.

See Also:

Constant Field Values

DESCRIPTION_ATTRIBUTE

public static final String DESCRIPTION_ATTRIBUTE

The name of the Attribute representing The description of the ControllerPlan.

See Also:

Constant Field Values

NODECOUNT_ATTRIBUTE

public static final String NODECOUNT_ATTRIBUTE

The name of the Attribute representing The number of Nodes expected by the plan.

See Also:

Constant Field Values

NODECAPABILITYBYPOSITION_ATTRIBUTE

public static final String NODECAPABILITYBYPOSITION_ATTRIBUTE

The name of the Attribute representing The capability of Node required for each of the expected Nodes, arranged in the array by Node position.

See Also:

Constant Field Values

NODELABELBYPOSITION_ATTRIBUTE

public static final String NODELABELBYPOSITION_ATTRIBUTE

The name of the Attribute representing the labels used to identify an assigned Node by its position.

See Also:

Constant Field Values

PLANTABLELIST_ATTRIBUTE

public static final String PLANTABLELIST_ATTRIBUTE

The name of the Attribute representing Reference to object holding the details describing the plan.

See Also:

Constant Field Values

Constructor Detail

ControllerPlan

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

Construct a ControllerPlan object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

Method Detail

hasNameAttribute

public boolean hasNameAttribute()
                         throws IfsException

Description copied from class: LibraryObject

Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.

Overrides:

hasNameAttribute in class LibraryObject

Returns:

true if the object has a NAME attribute.

Throws:

IfsException - if operation fails.

getUuid

public String getUuid()
               throws IfsException

Gets the value of the UUID attribute.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getDescription

public String getDescription()
                      throws IfsException

Gets The description of the ControllerPlan.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getNodeCount

public int getNodeCount()
                 throws IfsException

Gets the number of Nodes expected by the plan.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getNodeCapabilityByPosition

public String[] getNodeCapabilityByPosition()
                                     throws IfsException

Gets the capability of Node required for each of the expected Nodes, arranged in the array by Node position.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getNodeLabelByPosition

public String[] getNodeLabelByPosition()
                                throws IfsException

Gets the labels used to identify an assigned Node by its position.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getPlanTableList

public SimplePropertyTableList getPlanTableList()
                                         throws IfsException

Gets Reference to object holding the details describing the plan.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getObjectPropertyTable

public SimplePropertyTable getObjectPropertyTable()
                                           throws IfsException

Gets the SimplePropertyTable representing this object's metadata.

Is stored as the "Object Property Table of the SimplePropertyTableList.

Returns:

the Object PropertyTable

Throws:

IfsException - if the operation fails

getStartupPeriod

public String getStartupPeriod()
                        throws IfsException

Gets the startup time period, which is the duration to wait while assigning Nodes before automatically changing to a "fully started" state.

Returns:

the startup time period

Throws:

IfsException - if the operation fails

setStartupPeriod

public void setStartupPeriod(String val)
                      throws IfsException

Sets the startup time period, which is the duration to wait while assigning Nodes before automatically changing to a "fully started" state.

Parameters:

val - the startup time period

Throws:

IfsException - if the operation fails

getRecoveryPeriod

public String getRecoveryPeriod()
                         throws IfsException

Gets the recovery time period, which is the duration to wait before returning back to a "fully started" state after one or more assigned Nodes are no longer assigned.

Returns:

the recovery time period

Throws:

IfsException - if the operation fails

setRecoveryPeriod

public void setRecoveryPeriod(String val)
                       throws IfsException

Sets the recovery time period, which is the duration to wait before returning back to a "fully started" state after one or more assigned Nodes are no longer assigned.

Parameters:

val - the recovery time period

Throws:

IfsException - if the operation fails

isEveryAssignmentFinal

public boolean isEveryAssignmentFinal()
                               throws IfsException

Gets an indicator of whether every assignment entry should be considered as being defined as "final", meaning the classification hierarchy will not be checked further if no Node is defined at the lowest defined level.

Returns:

true if every assignemnt is treated as final

Throws:

IfsException - if the operation fails

setEveryAssignmentFinal

public void setEveryAssignmentFinal(boolean val)
                             throws IfsException

Sets an indicator of whether every assignment entry should be considered as being defined as "final", meaning the classification hierarchy will not be checked further if no Node is defined at the lowest defined level.

Parameters:

val - whether every assignemnt should be treated as final

Throws:

IfsException - if the operation fails

getAssignments

public List<AttributeValueTable> getAssignments()
                                         throws IfsException

Gets the set of assignment definitions for this plan.

Parameters:

assList - the set assignment value tables

Throws:

IfsException - if the operation fails

addAssignment

public void addAssignment(AttributeValueTable assignment)
                   throws IfsException

Adds an assignment to the map.

Parameters:

assignment - the assignment value table

Throws:

IfsException - if the operation fails

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySession session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find ControllerPlan instances by name.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

public static ControllerPlan[] findAll(LibrarySession session)
                                throws IfsException

Returns the set of defined ControllerPlans.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of ControllerPlans; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

public static ControllerPlan findByName(LibrarySession session,
                                        String name)
                                 throws IfsException

Returns the a ControllerPlan matching the specified name.

ControllerPlan names are case sensitive, so this operations requires an exact match with respect to case.

Parameters:

session - the session context

name - the ControllerPlan name

Returns:

the ControllerPlan matching the specified name; or null if there exists no matching ControllerPlan

Throws:

IfsException - if the operation fails.

postCreate

protected void postCreate(LibraryObjectDefinition lodef)
                   throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions after the creation of a object.

This method is typically overridden by subclasses that perform operations after an object is created. Subclasses are expected to invoke super.postCreate.

Overrides:

postCreate in class LibraryObject

Parameters:

lodef - object definition that was used to create the object

Throws:

IfsException - if operation fails.

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

This method is typically overridden by subclasses that perform other operations prior to the target object being freed in order to all delete or modify objects related to the target object. Subclasses are expected to invoke super.preFree.

Overrides:

preFree in class LibraryObject

Parameters:

lodef - object definition used to hold options related to the free operation

Throws:

IfsException - if operation fails.