oracle.ifs.beans

Class LifecyclePolicyDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SystemObjectDefinition

oracle.ifs.beans.LifecyclePolicyDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class LifecyclePolicyDefinition
extends SystemObjectDefinition

A LifecyclePolicyDefinition is used to create or modify a LifecyclePolicy instance.

Author:

Dave Long

See Also:

Serialized Form

(Unpublished)

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
LifecyclePolicyDefinition(LibrarySessionInterface session) Construct a definition explicitly capturing the session.
LifecyclePolicyDefinition(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	addLifecyclePolicyEntryDefinition(AttributeValueTable entryTable) Adds a new LifecyclePolicyEntryDefinition for a entry specified in a table.
void	addLifecyclePolicyEntryDefinition(LifecyclePolicyEntryDefinition def) Adds a new LifecyclePolicyEntry Definition.
void	addLifecyclePolicyEntryDefinitions(LifecyclePolicyEntryDefinition[] defs) Adds a set of new LifecyclePolicyEntry Definitions.
void	addLifecyclePolicyEntryDefinitions(List<AttributeValueTable> entryList) Adds a set of new LifecyclePolicyEntryDefinitions via a table list.
void	applySettings(AttributeValueTable avt) Applies settings from the specified table.
boolean	getDeleteAllLifecyclePolicyEntries() Gets indication as to whether all existing LifecyclePolicyEntries should be deleted as part of an update operation.
LifecyclePolicyEntryDefinition[]	getLifecyclePolicyEntryDefinitions() Returns all the LifecyclePolicyEntry Definitions defined on this instance.
void	removeLifecyclePolicyEntryDefinitions() Removes all LifecyclePolicyEntry Definition specifications from this instance.
void	setDeleteAllLifecyclePolicyEntries(boolean value) Sets indication as to whether all existing LifecyclePolicyEntries should be deleted as part of an update operation.
void	setLifecyclePolicyEntryDefinitions(LifecyclePolicyEntryDefinition[] defs) Defines a set of new LifecyclePolicyEntry Definitions.
static LifecyclePolicyDefinition	toLifecyclePolicyDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a LifecyclePolicyDefinition.
static LifecyclePolicyDefinition	toLifecyclePolicyDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a LifecyclePolicyDefinition.

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

LifecyclePolicyDefinition

public LifecyclePolicyDefinition(LibrarySessionInterface session)
                          throws IfsException

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

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

LifecyclePolicyDefinition

public LifecyclePolicyDefinition(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

(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 definition table

Throws:

IfsException - if the operation fails

(Published)

addLifecyclePolicyEntryDefinition

public void addLifecyclePolicyEntryDefinition(AttributeValueTable entryTable)
                                       throws IfsException

Adds a new LifecyclePolicyEntryDefinition for a entry specified in a table.

Parameters:

propTable - the Property table, which specifies key and value

Throws:

IfsException - if the operation fails

(Published)

addLifecyclePolicyEntryDefinitions

public void addLifecyclePolicyEntryDefinitions(List<AttributeValueTable> entryList)
                                        throws IfsException

Adds a set of new LifecyclePolicyEntryDefinitions via a table list.

Parameters:

entryList - the LifecyclePolicyEntry table list

Throws:

IfsException - if the operation fails

(Published)

addLifecyclePolicyEntryDefinition

public void addLifecyclePolicyEntryDefinition(LifecyclePolicyEntryDefinition def)
                                       throws IfsException

Adds a new LifecyclePolicyEntry Definition.

Parameters:

def - the LifecyclePolicyEntry definition

Throws:

IfsException - if the operation fails

addLifecyclePolicyEntryDefinitions

public void addLifecyclePolicyEntryDefinitions(LifecyclePolicyEntryDefinition[] defs)
                                        throws IfsException

Adds a set of new LifecyclePolicyEntry Definitions.

Parameters:

defs - the LifecyclePolicyEntry definitions

Throws:

IfsException - if the operation fails

setLifecyclePolicyEntryDefinitions

public void setLifecyclePolicyEntryDefinitions(LifecyclePolicyEntryDefinition[] defs)
                                        throws IfsException

Defines a set of new LifecyclePolicyEntry Definitions.

Parameters:

defs - the LifecyclePolicyEntry definitions

Throws:

IfsException - if the operation fails

removeLifecyclePolicyEntryDefinitions

public void removeLifecyclePolicyEntryDefinitions()
                                           throws IfsException

Removes all LifecyclePolicyEntry Definition specifications from this instance.

Throws:

IfsException - if the operation fails

getLifecyclePolicyEntryDefinitions

public LifecyclePolicyEntryDefinition[] getLifecyclePolicyEntryDefinitions()
                                                                    throws IfsException

Returns all the LifecyclePolicyEntry Definitions defined on this instance.

Return null if no LifecyclePolicyEntry definitions are defined.

Returns:

LifecyclePolicyEntry Definitions for this instance

Throws:

IfsException - if the operation fails

setDeleteAllLifecyclePolicyEntries

public void setDeleteAllLifecyclePolicyEntries(boolean value)
                                        throws IfsException

Sets indication as to whether all existing LifecyclePolicyEntries should be deleted as part of an update operation.

Parameters:

value - the value of the option; true indicates that the existing entries should be deleted

Throws:

IfsException - if the operation fails

getDeleteAllLifecyclePolicyEntries

public boolean getDeleteAllLifecyclePolicyEntries()
                                           throws IfsException

Gets indication as to whether all existing LifecyclePolicyEntries should be deleted as part of an update operation.

Returns:

the value of the option; true indicates that the existing entries should be deleted

Throws:

IfsException - if the operation fails

toLifecyclePolicyDefinition

public static LifecyclePolicyDefinition toLifecyclePolicyDefinition(LibraryObjectDefinition lodef)
                                                             throws IfsException

Cast specified LibraryObjectDefinition to a LifecyclePolicyDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a LifecyclePolicyDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toLifecyclePolicyDefinition

public static LifecyclePolicyDefinition toLifecyclePolicyDefinition(LibraryObjectDefinition lodef,
                                                                    boolean enforceCompat)
                                                             throws IfsException

Cast specified LibraryObjectDefinition to a LifecyclePolicyDefinition.

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 LifecyclePolicyDefinition.

Parameters:

lodef - the definition to be casted

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

Returns:

a LifecyclePolicyDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Unpublished)