oracle.ifs.beans

Class FolderDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.FolderDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

CommunityDefinition, MailboxDefinition, MailFolderDefinition, MessageDefinition, SmartHomeDefinition

public class FolderDefinition
extends PublicObjectDefinition

The FolderDefinition class is used to construct a Folder object. This subclass of PublicObjectDefinition sets the default ClassObject to "FOLDER".

Version:

1.0

Author:

Dave Long

See Also:

LibrarySession.createPublicObject(oracle.ifs.beans.PublicObjectDefinition), Serialized Form

(Published)

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

Method Summary

Modifier and Type	Method and Description
int	getFolderDepthOption() Gets the Folder depth system option that is set.
Integer	getFolderIndexLevelOption() Gets the FolderIndex Level option that was set previously.
void	setFolderDepthOption(int depth) Sets the Folder depth system option.
void	setFolderIndexLevelOption(int level) Sets the FolderIndex Level option.
static FolderDefinition	toFolderDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a FolderDefinition.
static FolderDefinition	toFolderDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a FolderDefinition.

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

FolderDefinition

public FolderDefinition(LibrarySessionInterface session)
                 throws IfsException

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

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

FolderDefinition

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

setFolderDepthOption

public void setFolderDepthOption(int depth)
                          throws IfsException

Sets the Folder depth system option. This option is only valid for free operations.

Parameters:

depth - folder depth system option

Throws:

IfsException - if the operation fails

(Published)

getFolderDepthOption

public int getFolderDepthOption()
                         throws IfsException

Gets the Folder depth system option that is set.

Returns:

Folder depth system option;

Throws:

IfsException - if the operation fails

(Published)

setFolderIndexLevelOption

public void setFolderIndexLevelOption(int level)
                               throws IfsException

Sets the FolderIndex Level option.

This option is only valid for create operations.

Parameters:

level - the desired folder index level for the new folder

Throws:

IfsException - if the operation fails

(Unpublished)

getFolderIndexLevelOption

public Integer getFolderIndexLevelOption()
                                  throws IfsException

Gets the FolderIndex Level option that was set previously.

Returns null if the option is not set.

Returns:

the desired folder index level for the new folder

Throws:

IfsException - if the operation fails

(Unpublished)

toFolderDefinition

public static FolderDefinition toFolderDefinition(LibraryObjectDefinition lodef)
                                           throws IfsException

Cast specified LibraryObjectDefinition to a FolderDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a FolderDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toFolderDefinition

public static FolderDefinition toFolderDefinition(LibraryObjectDefinition lodef,
                                                  boolean enforceCompat)
                                           throws IfsException

Cast specified LibraryObjectDefinition to a FolderDefinition.

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

Parameters:

lodef - the definition to be casted

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

Returns:

a FolderDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Unpublished)