oracle.ifs.beans

Class DirectoryUserDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.DirectoryObjectDefinition

oracle.ifs.beans.DirectoryUserDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class DirectoryUserDefinition
extends DirectoryObjectDefinition

A DirectoryUserDefinition is used to create or update a DirectoryUser.

All of the specifications can be set using the setAttribute() method inherited from its superclass.

Version:

1.0

Author:

Dave Long

See Also:

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

Method Summary

Modifier and Type	Method and Description
PrimaryUserProfileDefinition	getPrimaryUserProfileDefinition() Gets the PrimaryUserProfile definition describing the profile to be added as part of user creation, set previously via setPrimaryUserProfileDefinition
void	setPrimaryUserProfileDefinition(PrimaryUserProfileDefinition def) Sets the PrimaryUserProfile definition describing the profile to be added as part of user creation.
static DirectoryUserDefinition	toDirectoryUserDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a DirectoryUserDefinition.
static DirectoryUserDefinition	toDirectoryUserDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a DirectoryUserDefinition.

Methods inherited from class oracle.ifs.beans.DirectoryObjectDefinition

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

DirectoryUserDefinition

public DirectoryUserDefinition(LibrarySessionInterface session)
                        throws IfsException

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

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

DirectoryUserDefinition

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

setPrimaryUserProfileDefinition

public void setPrimaryUserProfileDefinition(PrimaryUserProfileDefinition def)
                                     throws IfsException

Sets the PrimaryUserProfile definition describing the profile to be added as part of user creation.

Parameters:

def - definition of the PrimaryUserProfile to create as part of user creation

Throws:

IfsException - if operation fails.

(Published)

getPrimaryUserProfileDefinition

public PrimaryUserProfileDefinition getPrimaryUserProfileDefinition()
                                                             throws IfsException

Gets the PrimaryUserProfile definition describing the profile to be added as part of user creation, set previously via setPrimaryUserProfileDefinition

Throws:

IfsException - if the operation fails

(Published)

toDirectoryUserDefinition

public static DirectoryUserDefinition toDirectoryUserDefinition(LibraryObjectDefinition lodef)
                                                         throws IfsException

Cast specified LibraryObjectDefinition to a DirectoryUserDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a DirectoryUserDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toDirectoryUserDefinition

public static DirectoryUserDefinition toDirectoryUserDefinition(LibraryObjectDefinition lodef,
                                                                boolean enforceCompat)
                                                         throws IfsException

Cast specified LibraryObjectDefinition to a DirectoryUserDefinition.

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

Parameters:

lodef - the definition to be casted

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

Returns:

a DirectoryUserDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Unpublished)