oracle.ifs.beans

Class ActivitySpecificationDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SystemObjectDefinition

oracle.ifs.beans.ActivitySpecificationDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class ActivitySpecificationDefinition
extends SystemObjectDefinition

A ActivitySpecificationDefinition is used to create or modify a ActivitySpecification 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
ActivitySpecificationDefinition(LibrarySessionInterface session) Construct a definition explicitly capturing the session.
ActivitySpecificationDefinition(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	applySettings(AttributeValueTable avt) Applies settings from the specified table.
ActionSpecification[]	getActionSpecifications() Gets the ActionSpecifications that are defined.
ClassObject	getActivityRecordClass() Gets the PerformedActivitySpecification, if explicitly set.
ActivitySpecification	getSuperActivitySpecification() Gets the SuperActivitySpecification, if explicitly set.
void	setActionSpecifications(ActionSpecification[] anSpecs) Sets the ActionSpecifications that represent the Actions that can be posted for the related ActivitySpecification instance.
void	setActivityRecordClass(ClassObject recordClass) Sets the ClassObject to use for new ActivityRecords.
void	setSuperActivitySpecification(ActivitySpecification spec) Sets the SuperActivitySpecification.
static ActivitySpecificationDefinition	toActivitySpecificationDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a ActivitySpecificationDefinition.
static ActivitySpecificationDefinition	toActivitySpecificationDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a ActivitySpecificationDefinition.

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

ActivitySpecificationDefinition

public ActivitySpecificationDefinition(LibrarySessionInterface session)
                                throws IfsException

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

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

ActivitySpecificationDefinition

public ActivitySpecificationDefinition(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)

getActivityRecordClass

public ClassObject getActivityRecordClass()
                                   throws IfsException

Gets the PerformedActivitySpecification, if explicitly set.

Returns:

the PerformedActivitySpecification setting, or null if not set

Throws:

IfsException - if operation fails

getActionSpecifications

public ActionSpecification[] getActionSpecifications()
                                              throws IfsException

Gets the ActionSpecifications that are defined.

Returns:

the ActionSpecifications setting, or null if not set

Throws:

IfsException - if operation fails

getSuperActivitySpecification

public ActivitySpecification getSuperActivitySpecification()
                                                    throws IfsException

Gets the SuperActivitySpecification, if explicitly set.

Returns:

the SuperActivitySpecification setting, or null if not set

Throws:

IfsException - if operation fails

setActivityRecordClass

public void setActivityRecordClass(ClassObject recordClass)
                            throws IfsException

Sets the ClassObject to use for new ActivityRecords.

Parameters:

recordClass - the ClassObject to use for new ActivityRecords.

Throws:

IfsException - if operation fails

setActionSpecifications

public void setActionSpecifications(ActionSpecification[] anSpecs)
                             throws IfsException

Sets the ActionSpecifications that represent the Actions that can be posted for the related ActivitySpecification instance.

Parameters:

anSpecs - the ActionSpecifications

Throws:

IfsException - if the operation fails

(Published)

setSuperActivitySpecification

public void setSuperActivitySpecification(ActivitySpecification spec)
                                   throws IfsException

Sets the SuperActivitySpecification.

Parameters:

spec - the SuperActivitySpecification setting

Throws:

IfsException - if operation fails

toActivitySpecificationDefinition

public static ActivitySpecificationDefinition toActivitySpecificationDefinition(LibraryObjectDefinition lodef)
                                                                         throws IfsException

Cast specified LibraryObjectDefinition to a ActivitySpecificationDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a ActivitySpecificationDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toActivitySpecificationDefinition

public static ActivitySpecificationDefinition toActivitySpecificationDefinition(LibraryObjectDefinition lodef,
                                                                                boolean enforceCompat)
                                                                         throws IfsException

Cast specified LibraryObjectDefinition to a ActivitySpecificationDefinition.

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

Parameters:

lodef - the definition to be casted

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

Returns:

a ActivitySpecificationDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Unpublished)