oracle.ifs.beans

Class PrimaryUserProfile

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.UserProfile

oracle.ifs.beans.TieUserProfile

oracle.ifs.beans.PrimaryUserProfile

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

Direct Known Subclasses:

TiePrimaryUserProfile

public class PrimaryUserProfile
extends TieUserProfile

A PrimaryUserProfile contains information related to a DirectoryUser such as the home folder, the default ACLs, ContentQuota.

Version:

1.0

Author:

Dave Long

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHARACTERSET_ATTRIBUTE The DirectoryUser's character set preference for document uploading.
static String	CLASS_NAME This class name for this class.
static String	CONTENTQUOTA_ATTRIBUTE The DirectoryUser's information about how much storage the user has allocated/consumed.
static String	DEFAULTACLS_ATTRIBUTE A PropertyBundle containing the name/value pairs keyed by the class name of the AccessControlList to use when creating an instance of that class.
static String	DISPLAYNAME_ATTRIBUTE The DirectoryUser's display name.
static String	EMAILADDRESS_ATTRIBUTE The DirectoryUser's Email Address.
static String	HOMEFOLDER_ATTRIBUTE The DirectoryUser's home folder.
static String	LANGUAGE_ATTRIBUTE The DirectoryUser's language preference for document uploading.
static String	LOCALE_ATTRIBUTE The DirectoryUser's locale preference.
static String	READINDICATIONENABLED_ATTRIBUTE An indicator of whether read indication is enabled or disabled.
static String	READINDICATIONSTATE_ATTRIBUTE An indicator of which documents' content the DirectoryUser has read.
static String	TIMEZONE_ATTRIBUTE The DirectoryUser's time zone preference.

Fields inherited from class oracle.ifs.beans.UserProfile

DIRECTORYUSER_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.PublicObject

ACL_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MARKED, FLAG_NOINFERIOR, FLAG_NOSELECT, FLAG_NTFS_ARCHIVE, FLAG_NTFS_HIDDEN, FLAG_NTFS_READONLY, FLAG_NTFS_SYSTEM, FLAG_UNMARKED, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKENTRIES_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PRIMARYPARENTFOLDER_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrimaryUserProfile(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs a PrimaryUserProfile.

Method Summary

Modifier and Type	Method and Description
protected static PrimaryUserProfile	constructPrimaryUserProfile(LibrarySession sess, S_LibraryObjectData data) Constructs a PrimaryUserProfile object from the definition object.
protected static Vector	constructPrimaryUserProfileVector(LibrarySession sess, Vector vector) Returns PrimaryUserProfile Vector from a Vector of PrimaryUserProfile
static PrimaryUserProfile[]	findByHomeFolder(Folder folder) Gets all the PrimaryUserProfile objects associated with a specified Home folder.
String	getCharacterSet() Retrieves the default Iana character set setting used when uploading a document.
ContentQuota	getContentQuota() Gets the DirectoryUser's ContentQuota object.
AccessControlList	getDefaultAcl() Gets the DirectoryUser's default ACL.
PropertyBundle	getDefaultAcls() Gets the PropertyBundle for this profile that contains name/value pairs keyed by classname of the default ACL to use when creating an instance of that class.
String	getDisplayName() Gets the name of the DirectoryUser that is used for display purposes.
String	getEmailAddress() Gets the name of the DirectoryUser that is used for display purposes.
Folder	getHomeFolder() Gets the DirectoryUser's home folder.
String	getLanguage() Retrieve the default language setting used when uploading a document.
Locale	getLocale() Retrieves the user preferred locale.
TimeZone	getTimeZone() Retrieves the user preferred time zone.
boolean	isReadIndicationEnabled() Determines whether read indication is enabled.
void	putDefaultAcl(String className, AccessControlList acl) Sets the default ACL for a specified class.
void	removeAllDefaultAcls() Removes all the default ACLs.
void	removeDefaultAcl(String className) Removes the default ACL to the specified class name.
void	setCharacterSet(String charSet) Sets the default character set setting to use when uploading a document.
void	setContentQuota(ContentQuota quota) Sets the DirectoryUser's ContentQuota attribute.
void	setDefaultAcl(AccessControlList acl) Sets the default ACL for the PUBLICOBJECT class only.
void	setDefaultAcls(PropertyBundle props) Sets the PropertyBundle for this profile that contains name/value pairs keyed by classname of the default ACL to use when creating an instance of that class.
void	setDisplayName(String name) Sets the name of the DirectoryUser that is used for display purposes.
void	setEmailAddress(String email) Sets the Email address of the DirectoryUser.
void	setHomeFolder(Folder folder) Sets the DirectoryUser's home folder.
void	setLanguage(String language) Sets the default language setting to use when uploading a document.
void	setLocale(Locale locale) Sets the user preferred locale.
void	setReadIndicationEnabled(boolean enable) Read indication can be enabled or disabled.
void	setTimeZone(TimeZone timeZone) Sets the user preferred time zone.

Methods inherited from class oracle.ifs.beans.UserProfile

constructUserProfile, constructUserProfileVector, getDirectoryUser

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, auditPublicObjectLocked, auditPublicObjectUnlocked, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, capabilities, checkAuditViewCapability, checkCapabilities, checkCapability, checkEffectiveAccess, checkEffectiveAccess, checkLockAccess, checkParentFolderCapability, checkVersioned, clearFlags, constructPublicObject, constructPublicObjectArray, constructPublicObjectVector, containsLockEntry, copy, coreAutoFolderingEnabled, createCategories, createDedicatedPolicyPropertyBundle, delete, deriveEffectiveAccessLevel, findAttachmentRelation, findOrAddActivityRecord, findOrAddActivityRecord, findOrAddActor, findOrAddActor, findOrAddMessageList, findOrAddMessageList, free, getAcl, getActivityRecord, getActor, getAllFolderPaths, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getAnyFolderPath, getAttachmentRelation, getAttachmentRelations, getAttachments, getCapabilities, getCategories, getCategories, getCategories, getCategories, getCategories, getCategory, getConsumedStorage, getCreateDate, getCreator, getDefaultAccessLevel, getDefinitionForSimplePropertyUpdates, getDeletor, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFirstCategory, getFirstVersion, getFlags, getFolderReferences, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLastVersion, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLeftwardRelationshipsCount, getLeftwardRelationshipsCount, getLinks, getLockEntries, getLockEntries, getLockObject, getLockRestrictions, getLockTypeAuditProperties, getMessageList, getNextVersion, getOwner, getPolicyBundle, getPolicyLists, getPreviousVersion, getPrimaryFolderPath, getPrimaryFolderPathIds, getPrimaryParentFolder, getPrimaryParentFolder, getRelations, getReservationComment, getReservationDate, getReservor, getResolvedPublicObject, getRestrictingLockEntries, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, getSingletonVersionDescription, getVersionNumber, getVersions, getVersionSeries, getWorkingCopy, grantAccess, handleCopy, handleCreate, handleUnlockAll, hasActivityRecord, hasActor, hasAttachmentRelation, hasCategories, hasCategory, hasConfigurationCategories, hasMessageList, hasNameAttribute, hasPropertyBundleAttribute, isAttachment, isDeleted, isLatestVersion, isLocked, isLockingSupported, isOwner, isReserved, isReservedByCurrentUser, isVersionable, isVersioned, isWorkingCopy, listLeftwardRelationships, listRightwardRelationships, lock, lock, lock, lock, newVersion, postCopy, postCreate, postSecurityChangedEvent, postUpdate, preCopy, preCreate, preFree, preUpdate, putPolicy, reassociateLinks, removeAllPolicies, removeAttachment, removePolicy, removePolicy, removeRelationship, reserveNext, resetFolderReferences, resolveFolderReferenceSortSpecification, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setLockEntries, setLockEntrySecurity, setOwner, setOwnerByName, setPolicyBundle, setPolicyLists, setSecuringPublicObject, toPublicObjectArray, undelete, unlock, unlock, unlockAll, unReserve, updateFlags, updateLock, vectorPublicObjectElement, vectorToPublicObjectArray, verifyAddRelationshipCapability, verifyCapabilities, verifyCapability, verifyDeleteCapability, verifyLockCapability, verifyRemoveRelationshipCapability, verifyUnlockCapability, verifyVersionSeries

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

This class name for this class. Useful for methods that take a class name argument.

See Also:

Constant Field Values

(Published)

HOMEFOLDER_ATTRIBUTE

public static final String HOMEFOLDER_ATTRIBUTE

The DirectoryUser's home folder.

See Also:

Constant Field Values

(Published)

DEFAULTACLS_ATTRIBUTE

public static final String DEFAULTACLS_ATTRIBUTE

A PropertyBundle containing the name/value pairs keyed by the class name of the AccessControlList to use when creating an instance of that class.

See Also:

Constant Field Values

(Published)

READINDICATIONSTATE_ATTRIBUTE

public static final String READINDICATIONSTATE_ATTRIBUTE

An indicator of which documents' content the DirectoryUser has read.

See Also:

Constant Field Values

(Published)

READINDICATIONENABLED_ATTRIBUTE

public static final String READINDICATIONENABLED_ATTRIBUTE

An indicator of whether read indication is enabled or disabled.

See Also:

Constant Field Values

(Published)

CONTENTQUOTA_ATTRIBUTE

public static final String CONTENTQUOTA_ATTRIBUTE

The DirectoryUser's information about how much storage the user has allocated/consumed.

See Also:

Constant Field Values

(Published)

LANGUAGE_ATTRIBUTE

public static final String LANGUAGE_ATTRIBUTE

The DirectoryUser's language preference for document uploading.

See Also:

Constant Field Values

(Published)

CHARACTERSET_ATTRIBUTE

public static final String CHARACTERSET_ATTRIBUTE

The DirectoryUser's character set preference for document uploading.

See Also:

Constant Field Values

(Published)

LOCALE_ATTRIBUTE

public static final String LOCALE_ATTRIBUTE

The DirectoryUser's locale preference. This attribute is stored according to the format specified under the Java API Specification.

See Also:

Constant Field Values

(Published)

TIMEZONE_ATTRIBUTE

public static final String TIMEZONE_ATTRIBUTE

The DirectoryUser's time zone preference.

See Also:

Constant Field Values

(Published)

DISPLAYNAME_ATTRIBUTE

public static final String DISPLAYNAME_ATTRIBUTE

The DirectoryUser's display name.

See Also:

Constant Field Values

(Published)

EMAILADDRESS_ATTRIBUTE

public static final String EMAILADDRESS_ATTRIBUTE

The DirectoryUser's Email Address.

See Also:

Constant Field Values

(Published)

Constructor Detail

PrimaryUserProfile

protected PrimaryUserProfile(LibrarySession session,
                             Long id,
                             Long classId,
                             S_LibraryObjectData data)
                      throws IfsException

Constructs a PrimaryUserProfile.

Parameters:

session - the session

id - the id

classId - the class id

data - data component

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

getHomeFolder

public Folder getHomeFolder()
                     throws IfsException

Gets the DirectoryUser's home folder. This is one of the user profile settings.

Returns:

DirectoryUser's home folder

Throws:

IfsException - if the operation fails

(Published)

setHomeFolder

public void setHomeFolder(Folder folder)
                   throws IfsException

Sets the DirectoryUser's home folder.

Parameters:

folder - the Folder that will be the home folder

Throws:

IfsException - if the operation fails

(Published)

getContentQuota

public ContentQuota getContentQuota()
                             throws IfsException

Gets the DirectoryUser's ContentQuota object.

Returns:

the DirectoryUser's ContentQuota or null if the DirectoryUser does not have any quota

Throws:

IfsException - if the operation fails

(Published)

setContentQuota

public void setContentQuota(ContentQuota quota)
                     throws IfsException

Sets the DirectoryUser's ContentQuota attribute.

Parameters:

quota - the DirectoryUser's ContentQuota

Throws:

IfsException - if the operation fails

(Published)

getDefaultAcls

public PropertyBundle getDefaultAcls()
                              throws IfsException

Gets the PropertyBundle for this profile that contains name/value pairs keyed by classname of the default ACL to use when creating an instance of that class.

Returns:

PropertyBundle containing default ACLs keyed by class name

Throws:

IfsException - if the operation fails

(Published)

setDefaultAcls

public void setDefaultAcls(PropertyBundle props)
                    throws IfsException

Sets the PropertyBundle for this profile that contains name/value pairs keyed by classname of the default ACL to use when creating an instance of that class.

Parameters:

props - PropertyBundle containing default ACLs keyed by class name

Throws:

IfsException - if the operation fails

(Published)

getDefaultAcl

public AccessControlList getDefaultAcl()
                                throws IfsException

Gets the DirectoryUser's default ACL. This is one of the user profile settings.

Returns:

the DirectoryUser's default ACL

Throws:

IfsException - if the operation fails

(Unpublished)

setDefaultAcl

public void setDefaultAcl(AccessControlList acl)
                   throws IfsException

Sets the default ACL for the PUBLICOBJECT class only.

Parameters:

acl - a valid ACL object

Throws:

IfsException - if the operation fails

(Unpublished)

putDefaultAcl

public void putDefaultAcl(String className,
                          AccessControlList acl)
                   throws IfsException

Sets the default ACL for a specified class.

Parameters:

className - name of the class

acl - a valid ACL object

Throws:

IfsException - if the operation fails

(Unpublished)

setLanguage

public void setLanguage(String language)
                 throws IfsException

Sets the default language setting to use when uploading a document. If left or set to NULL, uploads will use the default system settings.

Parameters:

language - Identifier code of Oracle language to use.

Throws:

IfsException - if the operation fails.

(Published)

getLanguage

public String getLanguage()
                   throws IfsException

Retrieve the default language setting used when uploading a document.

Returns:

Identifier code of the Oracle language being used.

Throws:

IfsException - if the operation fails.

(Published)

setCharacterSet

public void setCharacterSet(String charSet)
                     throws IfsException

Sets the default character set setting to use when uploading a document. If left or set to NULL, uploads will use the default system settings. Be sure to use the Iana character set name. (i.e. ISO-8859-1)

Parameters:

charSet - Identifier code of Iana character set to use.

Throws:

IfsException - if the operation fails.

(Published)

getCharacterSet

public String getCharacterSet()
                       throws IfsException

Retrieves the default Iana character set setting used when uploading a document.

Returns:

Identifier code of the Iana character set used.

Throws:

IfsException - if the operation fails.

(Published)

setTimeZone

public void setTimeZone(TimeZone timeZone)
                 throws IfsException

Sets the user preferred time zone.

Parameters:

timeZone - TimeZone which user would like to use.

Throws:

IfsException - if the operation fails.

(Published)

getTimeZone

public TimeZone getTimeZone()
                     throws IfsException

Retrieves the user preferred time zone.

Returns:

TimeZone which user prefers to use.

Throws:

IfsException - if the operation fails.

(Published)

setLocale

public void setLocale(Locale locale)
               throws IfsException

Sets the user preferred locale.

Parameters:

locale - User preferred locale setting.

Throws:

IfsException - if the operation fails.

(Published)

getLocale

public Locale getLocale()
                 throws IfsException

Retrieves the user preferred locale.

Returns:

User preferred locale setting.

Throws:

IfsException - if the operation fails.

(Published)

setDisplayName

public void setDisplayName(String name)
                    throws IfsException

Sets the name of the DirectoryUser that is used for display purposes.

Parameters:

name - Display name of the DirectoryUser

Throws:

IfsException - if the operation fails.

(Published)

getDisplayName

public String getDisplayName()
                      throws IfsException

Gets the name of the DirectoryUser that is used for display purposes.

Returns:

Display name of the DirectoryUser

Throws:

IfsException - if the operation fails.

(Published)

setEmailAddress

public void setEmailAddress(String email)
                     throws IfsException

Sets the Email address of the DirectoryUser.

Parameters:

email - Email address for the DirectoryUser

Throws:

IfsException - if the operation fails.

(Published)

getEmailAddress

public String getEmailAddress()
                       throws IfsException

Gets the name of the DirectoryUser that is used for display purposes.

Returns:

Email address for the DirectoryUser

Throws:

IfsException - if the operation fails.

(Published)

removeDefaultAcl

public void removeDefaultAcl(String className)
                      throws IfsException

Removes the default ACL to the specified class name.

Parameters:

className - name of the class

Throws:

IfsException - if the operation fails

(Unpublished)

removeAllDefaultAcls

public void removeAllDefaultAcls()
                          throws IfsException

Removes all the default ACLs.

Throws:

IfsException - if the operation fails

(Unpublished)

findByHomeFolder

public static PrimaryUserProfile[] findByHomeFolder(Folder folder)
                                             throws IfsException

Gets all the PrimaryUserProfile objects associated with a specified Home folder.

A non-null Folder must be specified. Typically one instance will be returned if the target object is a home folder for a user. A null array is returned if the specified folder is not a home folder.

Parameters:

folder - the home folder

Returns:

the associated PrimaryUserProfile objects

Throws:

IfsException - if the operation fails.

(Unpublished)

constructPrimaryUserProfileVector

protected static Vector constructPrimaryUserProfileVector(LibrarySession sess,
                                                          Vector vector)
                                                   throws IfsException

Returns PrimaryUserProfile Vector from a Vector of PrimaryUserProfile

Parameters:

sess - current LibrarySession

vector - vector of LibraryObjectData objects

Throws:

IfsException - if the operation fails

(Unpublished)

constructPrimaryUserProfile

protected static PrimaryUserProfile constructPrimaryUserProfile(LibrarySession sess,
                                                                S_LibraryObjectData data)
                                                         throws IfsException

Constructs a PrimaryUserProfile object from the definition object.

Parameters:

sess - current LibrarySession

data - data component

Throws:

IfsException - if the operation fails

(Unpublished)

isReadIndicationEnabled

public boolean isReadIndicationEnabled()
                                throws IfsException

Determines whether read indication is enabled.

Returns:

true if read indication is enabled

Throws:

IfsException - if the operation fails

(Published)

setReadIndicationEnabled

public void setReadIndicationEnabled(boolean enable)
                              throws IfsException

Read indication can be enabled or disabled.

Parameters:

enable - true if read indication should be effective.

Throws:

IfsException - if the operation fails

(Unpublished)