oracle.ifs.beans

Class CategoryDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.CategoryDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ActivityRecordDefinition, ActorDefinition, ConfigurationCategoryDefinition, InterMediaSourceDefinition, MessageListDefinition, MountPointDefinition, PostingDefinition, RelationDefinition, SportsStatisticsDefinition

public class CategoryDefinition
extends PublicObjectDefinition

A CategoryDefinition is used to define or update Category instances.

Version:

1.0

Author:

Dave Long

See Also:

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

Method Summary

Modifier and Type	Method and Description
boolean	getUpdateAssociatedObjectOption() Return the indication as to whether the associated PublicObject should or should not be updated as a result of a Category being added or removed.
void	setUpdateAssociatedObjectOption(boolean option) Set or clear the indication as to whether the associated PublicObject should or should not be updated as a result of a Category being added or removed.
static CategoryDefinition	toCategoryDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a CategoryDefinition.
static CategoryDefinition	toCategoryDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a CategoryDefinition.

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

CategoryDefinition

public CategoryDefinition(LibrarySessionInterface session)
                   throws IfsException

Construct a definition explicitly capturing the session.

The initial ClassObject will be Category.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

CategoryDefinition

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

setUpdateAssociatedObjectOption

public void setUpdateAssociatedObjectOption(boolean option)
                                     throws IfsException

Set or clear the indication as to whether the associated PublicObject should or should not be updated as a result of a Category being added or removed.

If the option is not set, the associated PublicObject will be updated.

Parameters:

option - true if the associated PublicObject will be updated as a result of category create or free.

Throws:

IfsException - if operation fails.

(Published)

getUpdateAssociatedObjectOption

public boolean getUpdateAssociatedObjectOption()
                                        throws IfsException

Return the indication as to whether the associated PublicObject should or should not be updated as a result of a Category being added or removed.

Returns:

true if the associated PublicObject will be updated as a result of category create or free.

Throws:

IfsException - if operation fails.

(Published)

toCategoryDefinition

public static CategoryDefinition toCategoryDefinition(LibraryObjectDefinition lodef)
                                               throws IfsException

Cast specified LibraryObjectDefinition to a CategoryDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a CategoryDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toCategoryDefinition

public static CategoryDefinition toCategoryDefinition(LibraryObjectDefinition lodef,
                                                      boolean enforceCompat)
                                               throws IfsException

Cast specified LibraryObjectDefinition to a CategoryDefinition.

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

Parameters:

lodef - the definition to be casted

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

Returns:

a CategoryDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Unpublished)