oracle.ifs.beans

Class CompositeGroupDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.DirectoryObjectDefinition

oracle.ifs.beans.DirectoryGroupDefinition

oracle.ifs.beans.CompositeGroupDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

CompositeScoutingGroupDefinition

public class CompositeGroupDefinition
extends DirectoryGroupDefinition

A CompositeGroupDefinition is used to create or modify a CompositeGroup instance.

Author:

Dave Long

See Also:

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

Method Summary

Modifier and Type	Method and Description
DirectoryGroup[]	getSortedMembers() Gets the sorted direct members.
AttributeValue	getSortedMembersValue() Gets the sorted direct members value.
void	setSortedMembers(DirectoryGroup[] sortedMems) Set the sorted direct members.
void	setSortedMembersValue(AttributeValue av) Set the sorted direct members value.
static CompositeGroupDefinition	toCompositeGroupDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a CompositeGroupDefinition.
static CompositeGroupDefinition	toCompositeGroupDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a CompositeGroupDefinition.

Methods inherited from class oracle.ifs.beans.DirectoryGroupDefinition

applySettings

Methods inherited from class oracle.ifs.beans.PublicObjectDefinition

addCategoryDefinition, addCategoryDefinition, addCategoryDefinitions, addCategoryDefinitions, 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

CompositeGroupDefinition

public CompositeGroupDefinition(LibrarySessionInterface session)
                         throws IfsException

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

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

CompositeGroupDefinition

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

(Published)

Method Detail

toCompositeGroupDefinition

public static CompositeGroupDefinition toCompositeGroupDefinition(LibraryObjectDefinition lodef)
                                                           throws IfsException

Cast specified LibraryObjectDefinition to a CompositeGroupDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a CompositeGroupDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Published)

toCompositeGroupDefinition

public static CompositeGroupDefinition toCompositeGroupDefinition(LibraryObjectDefinition lodef,
                                                                  boolean enforceCompat)
                                                           throws IfsException

Cast specified LibraryObjectDefinition to a CompositeGroupDefinition.

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

Parameters:

lodef - the definition to be casted

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

Returns:

a CompositeGroupDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Published)

setSortedMembersValue

public void setSortedMembersValue(AttributeValue av)
                           throws IfsException

Set the sorted direct members value.

Parameters:

av - the sorted members values

Throws:

IfsException - if the operation fails

(Published)

setSortedMembers

public void setSortedMembers(DirectoryGroup[] sortedMems)
                      throws IfsException

Set the sorted direct members.

Parameters:

sortedMems - the sorted members

Throws:

IfsException - if the operation fails

(Published)

getSortedMembersValue

public AttributeValue getSortedMembersValue()
                                     throws IfsException

Gets the sorted direct members value.

Returns:

the sorted direct members value.

Throws:

IfsException - if the operation fails

(Published)

getSortedMembers

public DirectoryGroup[] getSortedMembers()
                                  throws IfsException

Gets the sorted direct members.

Returns:

the sorted direct members.

Throws:

IfsException - if the operation fails

(Published)