oracle.ifs.core.beans

Class AuditTargetSpecification

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.core.beans.AuditTargetSpecification

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieAuditTargetSpecification

public class AuditTargetSpecification
extends TieSystemObject

Specifies properties about the target object for which an AuditSpecification has registered interest in AuditEvents.

Author:

Luis Saenz

See Also:

AuditSpecification

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	INCLUDEDESCENDENTS_ATTRIBUTE Whether to include descendents of the target object as additional target objects of interest.
static int	INCLUDEDESCENDENTS_DEEP An option for the INCLUDEDESCENDENTS attribute.
static int	INCLUDEDESCENDENTS_DIRECT An option for the INCLUDEDESCENDENTS attribute.
static int	INCLUDEDESCENDENTS_NONE An option for the INCLUDEDESCENDENTS attribute.
static String	TARGETOBJECTID_ATTRIBUTE The object ID for which the AuditSpecification has registered interest.

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, NAME_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuditTargetSpecification(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs an AuditTargetSpecification object.

Method Summary

Modifier and Type	Method and Description
int	getIncludeDescendents() Returns the include descendents option, which is a value of: INCLUDEDESCENDENTS_NONE, INCLUDEDESCENDENTS_DIRECT, or INCLUDEDESCENDENTS_DEEP.
Long	getTargetObjectId() Returns the ID of the target object.
boolean	isEventApplicable(AuditEvent event, AuditSpecification spec) Checks to see if the specified event is applicable to the specified AuditSpecification.
boolean	isEventApplicable(AuditEvent event, AuditSpecification spec, long targetIdVal, int inclDesc) Checks to see if the specified event is applicable to the specified AuditSpecification.

Methods inherited from class oracle.ifs.beans.SystemObject

addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, postCreate, postUpdate, preCreate, preUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists

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

TARGETOBJECTID_ATTRIBUTE

public static final String TARGETOBJECTID_ATTRIBUTE

The object ID for which the AuditSpecification has registered interest. (Long)

See Also:

Constant Field Values

INCLUDEDESCENDENTS_ATTRIBUTE

public static final String INCLUDEDESCENDENTS_ATTRIBUTE

Whether to include descendents of the target object as additional target objects of interest. (Integer; enum: {none, direct, deep})

See Also:

Constant Field Values

INCLUDEDESCENDENTS_NONE

public static final int INCLUDEDESCENDENTS_NONE

An option for the INCLUDEDESCENDENTS attribute. No descendents will be included.

See Also:

Constant Field Values

INCLUDEDESCENDENTS_DIRECT

public static final int INCLUDEDESCENDENTS_DIRECT

An option for the INCLUDEDESCENDENTS attribute. Only direct descendents will be included.

See Also:

Constant Field Values

INCLUDEDESCENDENTS_DEEP

public static final int INCLUDEDESCENDENTS_DEEP

An option for the INCLUDEDESCENDENTS attribute. All descendents (recursively) will be included.

See Also:

Constant Field Values

Constructor Detail

AuditTargetSpecification

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

Constructs an AuditTargetSpecification object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

Method Detail

getTargetObjectId

public Long getTargetObjectId()
                       throws IfsException

Returns the ID of the target object.

Returns:

the ID of the target object.

Throws:

IfsException - if the operation fails

getIncludeDescendents

public int getIncludeDescendents()
                          throws IfsException

Returns the include descendents option, which is a value of: INCLUDEDESCENDENTS_NONE, INCLUDEDESCENDENTS_DIRECT, or INCLUDEDESCENDENTS_DEEP.

Returns:

the include descendents option; defaults to INCLUDEDESCENDENTS_NONE if not specified

Throws:

IfsException - if the operation fails.

isEventApplicable

public boolean isEventApplicable(AuditEvent event,
                                 AuditSpecification spec)
                          throws IfsException

Checks to see if the specified event is applicable to the specified AuditSpecification.

Is only called when descendents option is INCLUDEDESCENDENTS_NONE.

Parameters:

event - the event to check

spec - the AuditSpecification to check

Returns:

true if the event is applicable; false otherwise

Throws:

IfsException - if the operation fails.

isEventApplicable

public boolean isEventApplicable(AuditEvent event,
                                 AuditSpecification spec,
                                 long targetIdVal,
                                 int inclDesc)
                          throws IfsException

Checks to see if the specified event is applicable to the specified AuditSpecification.

Is only called when descendents option is INCLUDEDESCENDENTS_NONE.

Parameters:

event - the event to check

spec - the AuditSpecification to check

targetIdVal - the target ID value for this instance

inclDesc - the descendents option for this instance

Returns:

true if the event is applicable; false otherwise

Throws:

IfsException - if the operation fails.