Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## oracle.ifs.core.beans
Class ServiceState

    java.lang.Object
      oracle.ifs.beans.LibraryObject
          oracle.ifs.beans.TieLibraryObject
              oracle.ifs.beans.SystemObject
                  oracle.ifs.beans.TieSystemObject
                      oracle.ifs.core.beans.RuntimeState
                          oracle.ifs.beans.TieRuntimeState
                              oracle.ifs.core.beans.ServiceState

All Implemented Interfaces:
  IfsEventHandler, LibraryObjectInterface, SystemObjectInterface, Traceable

Direct Known Subclasses:
  TieServiceState

    public class ServiceState

extends TieRuntimeState

A ServiceState tracks the runtime state of a LibraryService.

(Published)

Field Summary
`static java.lang.String` | `CLASS_NAME` The name of the ClassObject representing this class.
`static long` | `SERVICESTATE_EVENTPAYLOAD_DISPOSE` The event payload that identifies a Dispose Service request.

Fields inherited from class oracle.ifs.core.beans.RuntimeState
`CONFIGURATIONBUNDLE_ATTRIBUTE, CONFIGURATIONNAME_ATTRIBUTE, CONFIGURATIONOVERRIDEBUNDLE_ATTRIBUTE, CREATEDATE_ATTRIBUTE, DISPOSEDATE_ATTRIBUTE, NAME_ATTRIBUTE, RUNTIMESTATEBUNDLE_ATTRIBUTE`

Fields inherited from class oracle.ifs.beans.SystemObject
`ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE`

Fields inherited from class oracle.ifs.beans.LibraryObject
`DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session`

Constructor Summary
`protected` | `ServiceState(LibrarySession session, java.lang.Long id, java.lang.Long classId, S_LibraryObjectData data)` Constructs a ServiceState object.

Method Summary
`protected java.lang.String` | `getConfigurationOverrideAuditEventKey()` Gets the Audit Event key to use for posting configuration overrides.
`protected boolean` | `isValidEventType(AuditEvent event)` Checks to see if the event type in the process of being posted on the target LibraryObject is consistent with the target.
`void` | `postDisposeServiceRequest()` Posts a request to Dispose the Service.

Methods inherited from class oracle.ifs.core.beans.RuntimeState
`extractEventPayloadType, generateAuxiliaryNumberPayload, getAuditEvents, getConfigurationBundle, getConfigurationName, getConfigurationOverrideBundle, getConfigurationOverridePropertyValue, getConfigurationPropertyValue, getCreateDate, getDisposeDate, getRuntimeStateBundle, getRuntimeStatePropertyValue, hasNameAttribute, postAuditEvent, postAuditEvent, postAuditEvent, postAuditEvent, postAuditEvent, postConfigurationOverrideRequest, preFree, putConfigurationOverrideProperty, putConfigurationProperty, putRuntimeStateProperty, removeAllConfigurationOverrideProperties, removeAllConfigurationProperties, removeAllRuntimeStateProperties, removeConfigurationOverrideProperty, removeConfigurationProperty, removeRuntimeStateProperty, setConfigurationBundle, setConfigurationOverrideBundle, setDisposeDate, setDisposeDate, setRuntimeStateBundle`

Methods inherited from class oracle.ifs.beans.SystemObject
`addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, isActive, postCreate, postUpdate, preCreate, preUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists`

Methods inherited from class oracle.ifs.beans.LibraryObject
`applyProperties, auditCreated, auditUpdated, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, deriveDomainUniqueName, dispose, equals, free, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCopyContext, getCreateContext, getData, getDefinition, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isTraced, lockRows, lookupInstanceLabel, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeProperty, 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, verifySystemUserAccess, verifyTargetObject`

Methods inherited from class java.lang.Object
`clone, equals, 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 java.lang.String CLASS_NAME

  Description copied from class: `ServiceState`
  The name of the ClassObject representing this class.

  See Also:
    Constant Field Values
  (Published)

### SERVICESTATE_EVENTPAYLOAD_DISPOSE

    public static final long SERVICESTATE_EVENTPAYLOAD_DISPOSE

  Description copied from class: `ServiceState`
  The event payload that identifies a Dispose Service request.

  See Also:
    Constant Field Values
  (Published)

Constructor Detail

### ServiceState

    protected ServiceState(LibrarySession session,
                           java.lang.Long id,
                           java.lang.Long classId,
                           S_LibraryObjectData data)
                    throws IfsException

  Constructs a ServiceState object.

  Parameters:
    `session` - current LibrarySession
    `id` - object id
    `classId` - class id
    `data` - data component
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

Method Detail

### getConfigurationOverrideAuditEventKey

    protected java.lang.String getConfigurationOverrideAuditEventKey()
                                                              throws IfsException

  Description copied from class: `ServiceState`
  Gets the Audit Event key to use for posting configuration overrides.

  Overrides:
    `getConfigurationOverrideAuditEventKey` in class `RuntimeState`
  Returns:
    the Audit Event key
  Throws:
    `IfsException` - if the operation fails
  (Published)

### postDisposeServiceRequest

    public void postDisposeServiceRequest()
                                   throws IfsException

  Description copied from class: `ServiceState`
  Posts a request to Dispose the Service.

  Throws:
    `IfsException` - if the operation fails
  (Published)

### isValidEventType

    protected boolean isValidEventType(AuditEvent event)
                                throws IfsException

  Description copied from class: `ServiceState`
  Checks to see if the event type in the process of being posted on the target LibraryObject is consistent with the target.

  Overrides:
    `isValidEventType` in class `LibraryObject`
  Parameters:
    `event` - the event being posted on this object
  Returns:
    true if the type is consistent; false otherwise
  Throws:
    `IfsException` - if the operation fails

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD