oracle.ifs.core.beans

Class AuditSpecificationDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SystemObjectDefinition

oracle.ifs.core.beans.AuditSpecificationDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class AuditSpecificationDefinition
extends SystemObjectDefinition

An AuditSpecificationDefinition is used to create or modify an AuditSpecification instance.

Author:

Luis Saenz

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.beans.LibraryObjectDefinition

LibraryObjectDefinition.EnumToIntegerCode, LibraryObjectDefinition.LookupByName

Field Summary

Fields inherited from class oracle.ifs.beans.LibraryObjectDefinition

m_Attributes, m_ClassObjectName, m_ClassObjectValue, m_ContentSpecifications, m_DefinitionLists, m_Definitions, m_EnclosedDefinition, m_Id, m_Options, m_ReadOnly, m_ReferenceAttributes, m_Session, m_SystemOptions

Constructor Summary

Constructors

Constructor and Description
AuditSpecificationDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
AuditSpecificationDefinition(LibrarySessionInterface session, String className) Constructs a definition, explicitly capturing the session and setting the initial ClassObject.

Method Summary

Modifier and Type	Method and Description
void	applySettings(AttributeValueTable avt) Applies settings from the specified table.
AuditHandlerSpecificationDefinition	getAuditHandlerSpecificationDefinition() Gets the AuditHandlerSpecificationDefinition specifying the AuditHandlerSpecification for the AuditSpecification that is created or updated.
AuditTargetSpecificationDefinition	getAuditTargetSpecificationDefinition() Gets the AuditTargetSpecificationDefinition specifying the AuditTargetSpecification for the AuditSpecification that is created or updated.
AuditTypeListDefinition	getAuditTypeListDefinition() Gets the AuditTypeListDefinition specifying the AuditTypeList for the AuditSpecification that is created or updated.
void	setAuditHandlerSpecificationDefinition(AttributeValueTable avt) Sets the AuditTargetSpecificationDefinition specifying the AuditTargetSpecification for the AuditSpecification that is created or updated, using values specified in a table.
void	setAuditHandlerSpecificationDefinition(AuditHandlerSpecificationDefinition ahsDef) Gets the AuditHandlerSpecificationDefinition specifying the AuditHandlerSpecification for the AuditSpecification that is created or updated.
void	setAuditTargetSpecificationDefinition(AttributeValueTable avt) Sets the AuditTargetSpecificationDefinition specifying the AuditTargetSpecification for the AuditSpecification that is created or updated, using values specified in a table.
void	setAuditTargetSpecificationDefinition(AuditTargetSpecificationDefinition atsDef) Sets the AuditTargetSpecificationDefinition specifying the AuditTargetSpecification for the AuditSpecification that is created or updated.
void	setAuditTypeListDefinition(AttributeValueTable avt) Sets the AuditTypeListDefinition specifying the AuditTypeList for the AuditSpecification that is created or updated, using values specified in a table.
void	setAuditTypeListDefinition(AuditTypeListDefinition atlDef) Sets the AuditTypeListDefinition specifying the AuditTypeList for the AuditSpecification that is created or updated.
static AuditSpecificationDefinition	toAuditSpecificationDefinition(LibraryObjectDefinition lodef) Casts the specified LibraryObjectDefinition to an AuditSpecificationDefinition.
static AuditSpecificationDefinition	toAuditSpecificationDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Casts the specified LibraryObjectDefinition to an AuditSpecificationDefinition.

Methods inherited from class oracle.ifs.beans.SystemObjectDefinition

addCategoryDefinition, addCategoryDefinitionForUpdate, addCategoryDefinitions, addCategoryForDelete, getCategoriesForDelete, getCategoryDefinitions, getCategoryDefinitionsForUpdate, getCreateCategoriesServerSideOption, removeCategoriesForDelete, removeCategoryDefinitions, removeCategoryDefinitionsForUpdate, setCategoryDefinitions, setCreateCategoriesServerSideOption, toSystemObjectDefinition, toSystemObjectDefinition

Methods inherited from class oracle.ifs.beans.LibraryObjectDefinition

addDefinition, addDefinitions, addProperty, addPropertyDefinition, addPropertyDefinition, addPropertyDefinitions, addPropertyDefinitions, addSimplePropertyDefinition, addSimplePropertyDefinition, addSimplePropertyDefinitions, addSimplePropertyDefinitions, applyEnumSetting, applyEnumSetting, applyMapSetting, applyMapSetting, applyObjectArraySetting, applyObjectArraySetting, applyObjectSetting, applyObjectSetting, applySetting, applySetting, captureSession, captureSession, captureSession, clone, constructInstance, constructInstance, constructInstance, copyInto, deriveObjectArraySetting, deriveObjectSetting, getAttribute, getAttribute, getAttributes, getAttributes, getAttributesSorted, getClassId, getClassObject, getClassObjectValue, getContentSpecification, getContentSpecificationKeys, getCopiedObjectValue, getDefinition, getDefinitionClassName, getDefinitionKeys, getDefinitionListKeys, getDefinitions, getId, getLibrarySession, getName, getOption, getOptionAsAttributeValue, getOptionKeys, getPolicyMode, getPropertyDefinitions, getReferenceAttribute, getReferenceAttributes, getServerDefinition, getSession, getSimplePropertyDefinitions, getSLibrarySession, getStringAttribute, getSystemOption, getSystemOptionAsAttributeValue, getSystemOptionAsBoolean, getSystemOptionKeys, getWriteableInstance, isReadOnly, prepareForDefinitionObject, processSimplePropertiesForCreate, processSimplePropertiesForUpdate, removeAttribute, removeContentSpecification, removeDefinition, removeDefinitions, removeOption, removePropertyDefinitions, removeReferenceAttribute, removeSimplePropertyDefinitions, removeSystemOption, reset, resolve, setAttribute, setAttribute, setAttribute, setAttributeByUpperCaseName, setAttributeByUpperCaseName, setAttributePolicyMode, setAttributes, setClassId, setClassname, setClassObject, setClassObjectValue, setContentSpecification, setCopiedObjectValue, setDefinition, setDefinitions, setId, setName, setOption, setReadOnly, setReferenceAttribute, setReferenceAttribute, setSession, setSimplePropertyDefinitions, setSystemOption, unresolve, verifySession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuditSpecificationDefinition

public AuditSpecificationDefinition(LibrarySessionInterface session)
                             throws IfsException

Constructs a definition explicitly capturing the session. The initial ClassObject is AuditSpecification.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

AuditSpecificationDefinition

public AuditSpecificationDefinition(LibrarySessionInterface session,
                                    String className)
                             throws IfsException

Constructs a definition, explicitly capturing the session and setting the initial ClassObject.

Parameters:

session - the current session

className - the initial class name

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

applySettings

public void applySettings(AttributeValueTable avt)
                   throws IfsException

Applies settings from the specified table.

Overrides:

applySettings in class SystemObjectDefinition

Parameters:

avt - the table containing the settings

Throws:

IfsException - if the operation fails

(Published)

setAuditTypeListDefinition

public void setAuditTypeListDefinition(AuditTypeListDefinition atlDef)
                                throws IfsException

Sets the AuditTypeListDefinition specifying the AuditTypeList for the AuditSpecification that is created or updated.

Note: this takes precedence over an explicit AuditTypeList setting as an attribute.

Parameters:

atlDef - an AuditTypeListDefinition

Throws:

IfsException - if the operation fails

(Published)

setAuditTypeListDefinition

public void setAuditTypeListDefinition(AttributeValueTable avt)
                                throws IfsException

Sets the AuditTypeListDefinition specifying the AuditTypeList for the AuditSpecification that is created or updated, using values specified in a table.

Parameters:

avt - the AuditTypeList table

Throws:

IfsException - if the operation fails

(Published)

getAuditTypeListDefinition

public AuditTypeListDefinition getAuditTypeListDefinition()
                                                   throws IfsException

Gets the AuditTypeListDefinition specifying the AuditTypeList for the AuditSpecification that is created or updated.

Returns:

the AuditTypeListDefinition set previously

Throws:

IfsException - if the operation fails

(Published)

setAuditHandlerSpecificationDefinition

public void setAuditHandlerSpecificationDefinition(AuditHandlerSpecificationDefinition ahsDef)
                                            throws IfsException

Gets the AuditHandlerSpecificationDefinition specifying the AuditHandlerSpecification for the AuditSpecification that is created or updated.

Parameters:

ahsDef - an AuditHandlerSpecificationDefinition

Throws:

IfsException - if the operation fails

(Published)

setAuditHandlerSpecificationDefinition

public void setAuditHandlerSpecificationDefinition(AttributeValueTable avt)
                                            throws IfsException

Sets the AuditTargetSpecificationDefinition specifying the AuditTargetSpecification for the AuditSpecification that is created or updated, using values specified in a table.

Parameters:

avt - the table containing the settings

Throws:

IfsException - if the operation fails

(Published)

getAuditHandlerSpecificationDefinition

public AuditHandlerSpecificationDefinition getAuditHandlerSpecificationDefinition()
                                                                           throws IfsException

Gets the AuditHandlerSpecificationDefinition specifying the AuditHandlerSpecification for the AuditSpecification that is created or updated.

Returns:

the AuditHandlerSpecificationDefinition set previously

Throws:

IfsException - if the operation fails

(Published)

setAuditTargetSpecificationDefinition

public void setAuditTargetSpecificationDefinition(AuditTargetSpecificationDefinition atsDef)
                                           throws IfsException

Sets the AuditTargetSpecificationDefinition specifying the AuditTargetSpecification for the AuditSpecification that is created or updated.

Parameters:

atsDef - an AuditTargetSpecificationDefinition

Throws:

IfsException - if the operation fails

(Published)

setAuditTargetSpecificationDefinition

public void setAuditTargetSpecificationDefinition(AttributeValueTable avt)
                                           throws IfsException

Sets the AuditTargetSpecificationDefinition specifying the AuditTargetSpecification for the AuditSpecification that is created or updated, using values specified in a table.

Parameters:

avt - the table containing the settings

Throws:

IfsException - if the operation fails

(Published)

getAuditTargetSpecificationDefinition

public AuditTargetSpecificationDefinition getAuditTargetSpecificationDefinition()
                                                                         throws IfsException

Gets the AuditTargetSpecificationDefinition specifying the AuditTargetSpecification for the AuditSpecification that is created or updated.

Returns:

the AuditTargetSpecificationDefinition set previously

Throws:

IfsException - if the operation fails

(Published)

toAuditSpecificationDefinition

public static AuditSpecificationDefinition toAuditSpecificationDefinition(LibraryObjectDefinition lodef)
                                                                   throws IfsException

Casts the specified LibraryObjectDefinition to an AuditSpecificationDefinition.

Returns null if the specified definition is not an AuditSpecificationDefinition, or if the specified definition is null.

Parameters:

lodef - the definition to be casted

Returns:

an AuditSpecificationDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

toAuditSpecificationDefinition

public static AuditSpecificationDefinition toAuditSpecificationDefinition(LibraryObjectDefinition lodef,
                                                                          boolean enforceCompat)
                                                                   throws IfsException

Casts the specified LibraryObjectDefinition to an AuditSpecificationDefinition.

Returns null if the specified definition is null. If non-null and unable to cast, returns null if enforceCompat is false but throw an IfsException if the specified definition is not a AuditSpecificationDefinition.

Parameters:

lodef - the definition to be casted

enforceCompat - whether to throw an exception if a non-null definition cannot be cast

Returns:

an AuditSpecificationDefinition casted from the specified definition

Throws:

IfsException - 10822: if the operation fails.