oracle.ifs.core.beans

Class AuditTypeListDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SystemObjectDefinition

oracle.ifs.core.beans.AuditTypeListDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class AuditTypeListDefinition
extends SystemObjectDefinition

A AuditTypeListDefinition is used to create or modify a AuditTypeList instance.

Author:

Dave Long

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
AuditTypeListDefinition(LibrarySessionInterface session) Construct a definition explicitly capturing the session.
AuditTypeListDefinition(LibrarySessionInterface session, String className) Construct a definition, explicitly capturing the session and setting the initial classobject.

Method Summary

Modifier and Type	Method and Description
void	addAuditTypeEntryValue(AuditTypeEntryValue atev) Adds an AuditTypeEntryValue to the list of AuditTypeEntryValues.
void	addAuditTypeEntryValues(AuditTypeEntryValue[] atevs) Adds a set of AuditTypeEntryValues to the list of AuditTypeEntryValues.
void	addEventDefinition(AttributeValueTable eventsTable) Adds a set of event declarations from a table entry.
void	addEventDefinitions(List<AttributeValueTable> eventsList) Adds a set of event declarations via a table list.
void	applySettings(AttributeValueTable avt) Applies settings from the specified table.
ArrayList	getAuditTypeEntryValues() Returns the list of all AuditTypeEntryValues.
void	removeAuditTypeEntryValues() Removes all AuditTypeEntryValues from the list.
protected void	resolveAuditTypeEntryList(LibrarySession session) Resolves the list of getAuditTypeEntryValues, into embedded SystemObjectCategories.
void	setAuditTypeEntryValues(AuditTypeEntryValue[] atevs) Sets the AuditTypeEntryValues.
static AuditTypeListDefinition	toAuditTypeListDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a AuditTypeListDefinition.
static AuditTypeListDefinition	toAuditTypeListDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a AuditTypeListDefinition.

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

AuditTypeListDefinition

public AuditTypeListDefinition(LibrarySessionInterface session)
                        throws IfsException

Construct a definition explicitly capturing the session. The initial ClassObject will be AuditTypeList.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

AuditTypeListDefinition

public AuditTypeListDefinition(LibrarySessionInterface session,
                               String className)
                        throws IfsException

Construct 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

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)

addEventDefinitions

public void addEventDefinitions(List<AttributeValueTable> eventsList)
                         throws IfsException

Adds a set of event declarations via a table list.

Parameters:

eventsList - the event declarations table list

Throws:

IfsException - if the operation fails

(Published)

addEventDefinition

public void addEventDefinition(AttributeValueTable eventsTable)
                        throws IfsException

Adds a set of event declarations from a table entry.

Parameters:

eventsTable - the event declarations table

Throws:

IfsException - if the operation fails

(Published)

addAuditTypeEntryValue

public final void addAuditTypeEntryValue(AuditTypeEntryValue atev)
                                  throws IfsException

Adds an AuditTypeEntryValue to the list of AuditTypeEntryValues.

Parameters:

atev - the AuditTypeEntryValue to add

Throws:

IfsException - if the operation fails

(Published)

addAuditTypeEntryValues

public void addAuditTypeEntryValues(AuditTypeEntryValue[] atevs)
                             throws IfsException

Adds a set of AuditTypeEntryValues to the list of AuditTypeEntryValues.

Parameters:

atevs - the AuditTypeEntryValues

Throws:

IfsException - if the operation fails

(Unpublished)

setAuditTypeEntryValues

public void setAuditTypeEntryValues(AuditTypeEntryValue[] atevs)
                             throws IfsException

Sets the AuditTypeEntryValues.

All previously specified AuditTypeEntryValues will be removed, prior to adding this array to the instance.

Parameters:

atevs - the AuditTypeEntryValues

Throws:

IfsException - if the operation fails

(Unpublished)

removeAuditTypeEntryValues

public void removeAuditTypeEntryValues()
                                throws IfsException

Removes all AuditTypeEntryValues from the list.

Throws:

IfsException - if the operation fails

(Unpublished)

getAuditTypeEntryValues

public ArrayList getAuditTypeEntryValues()
                                  throws IfsException

Returns the list of all AuditTypeEntryValues.

Returns either null or an empty list if no entries are specified.

Returns:

the list of AuditTypeEntryValues; can be null or empty

Throws:

IfsException - if the operation fails

(Published)

resolveAuditTypeEntryList

protected void resolveAuditTypeEntryList(LibrarySession session)
                                  throws IfsException

Resolves the list of getAuditTypeEntryValues, into embedded SystemObjectCategories.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

toAuditTypeListDefinition

public static AuditTypeListDefinition toAuditTypeListDefinition(LibraryObjectDefinition lodef)
                                                         throws IfsException

Cast specified LibraryObjectDefinition to a AuditTypeListDefinition.

Return null if the specified definition is not a AuditTypeListDefinition, or if the specified definition is null.

Parameters:

lodef - the definition to be casted

Returns:

a AuditTypeListDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

toAuditTypeListDefinition

public static AuditTypeListDefinition toAuditTypeListDefinition(LibraryObjectDefinition lodef,
                                                                boolean enforceCompat)
                                                         throws IfsException

Cast specified LibraryObjectDefinition to a AuditTypeListDefinition.

Return null if the specified definition is null. If non-null and unable to cast, return null if enforceCompat is false but throw an IfsException if the specified definition is not a AuditTypeListDefinition.

Parameters:

lodef - the definition to be casted

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

Returns:

a AuditTypeListDefinition casted from the specified definition

Throws:

IfsException - 10822: if the operation fails.