oracle.ifs.core.tools.script.test.overrides.activity.community

Class CommunityDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.FolderDefinition

oracle.ifs.core.tools.script.test.overrides.activity.community.CommunityDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class CommunityDefinition
extends FolderDefinition

A CommunityDefinition is used to define or update Community instances.

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

Method Summary

Modifier and Type	Method and Description
AutoFolderingActionSpecification	getAutoFolderingActionSpec() Gets the AutoFolderingActionSpecification, if explicitly set.
void	setAutoFolderingActionSpec(AutoFolderingActionSpecification spec) Sets the AutoFolderingActionSpecification.
static CommunityDefinition	toCommunityDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a CommunityDefinition.
static CommunityDefinition	toCommunityDefinition(LibraryObjectDefinition lodef, boolean enforce) Cast specified LibraryObjectDefinition to a CommunityDefinition.

Methods inherited from class oracle.ifs.beans.FolderDefinition

getFolderDepthOption, getFolderIndexLevelOption, setFolderDepthOption, setFolderIndexLevelOption, toFolderDefinition, toFolderDefinition

Methods inherited from class oracle.ifs.beans.PublicObjectDefinition

addCategoryDefinition, addCategoryDefinition, addCategoryDefinitions, addCategoryDefinitions, applySettings, getAddToFolderOption, getAddToFolderValue, getAutoFolderingActionSpecification, getCascadeCopyRelationshipsOption, getCascadeCopyRelationshipsOptionValue, getCategoryCopyOption, getCategoryDefinitions, getContentQuotaCopyOption, getCreateCategoriesServerSideOption, getExplicitCreateAndModifyAttributesOption, getExplicitCreateDate, getExplicitLastModifyDate, getFreeIfLastFolderReferenceOption, getKeepLastModifierOption, getKeepLastModifyDateOption, getLockEntryDefinition, getLockObject, getLockObjectDefinition, getLockObjectValue, getSecuringPublicObject, getSecuringPublicObjectValue, getUpdatedLockObjectDefinition, removeCategoryDefinitions, removeLockEntryDefinition, resolveAutoFolderingSettings, setAddToFolderOption, setAddToFolderValue, setAutoFolderingActionSpecification, setAutoFolderingActionSpecification, setCascadeCopyRelationshipsOption, setCategoryCopyOption, setCategoryDefinitions, setContentQuotaCopyOption, setCreateCategoriesServerSideOption, setExplicitCreateAndModifyAttributesOption, setExplicitCreateDate, setExplicitLastModifyDate, setFreeIfLastFolderReferenceOption, setKeepLastModifierOption, setKeepLastModifyDateOption, setLockEntryDefinition, setLockObject, setLockObjectDefinition, setLockObjectValue, setNullSecurity, setPrivateSecurity, setPublishedSecurity, setSecuringPublicObject, setSecuringPublicObjectValue, setUpdatedLockObjectDefinition, toPublicObjectDefinition, toPublicObjectDefinition

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

CommunityDefinition

public CommunityDefinition(LibrarySessionInterface session)
                    throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be TestCommunity.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

CommunityDefinition

public CommunityDefinition(LibrarySessionInterface session,
                           String className)
                    throws IfsException

Construct a definition explicitly capturing the session and setting the initial ClassObject name.

Parameters:

session - the current session

className - the initial class name

Throws:

IfsException - if the operation fails

Method Detail

getAutoFolderingActionSpec

public AutoFolderingActionSpecification getAutoFolderingActionSpec()
                                                            throws IfsException

Gets the AutoFolderingActionSpecification, if explicitly set.

Returns:

the AutoFolderingActionSpecification setting, or null if not set

Throws:

IfsException - if operation fails

setAutoFolderingActionSpec

public void setAutoFolderingActionSpec(AutoFolderingActionSpecification spec)
                                throws IfsException

Sets the AutoFolderingActionSpecification.

Parameters:

spec - the AutoFolderingActionSpecification setting

Throws:

IfsException - if operation fails

toCommunityDefinition

public static CommunityDefinition toCommunityDefinition(LibraryObjectDefinition lodef)
                                                 throws IfsException

Cast specified LibraryObjectDefinition to a CommunityDefinition.

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

Parameters:

lodef - the definition to be cast

Returns:

a CommunityDefinition cast from the specified definition

Throws:

IfsException - if the operation fails

toCommunityDefinition

public static CommunityDefinition toCommunityDefinition(LibraryObjectDefinition lodef,
                                                        boolean enforce)
                                                 throws IfsException

Cast specified LibraryObjectDefinition to a CommunityDefinition.

Return null if the specified definition is null. If non-null and unable to cast, return null if enforceCompat is false but throw otherwise.

Parameters:

lodef - the definition to be cast

enforce - whether to throw an exception if cast fails

Returns:

a CommunityDefinition cast from the specified definition

Throws:

IfsException - if the operation fails (throws 10822)