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:

IfsEventHandler, LibraryObjectInterface, 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.

Field Summary

static java.lang.String	CHARACTERSET_ATTRIBUTE The DirectoryUser's character set preference for document uploading.
static java.lang.String	CLASS_NAME This class name for this class.
static java.lang.String	CONTENTQUOTA_ATTRIBUTE The DirectoryUser's information about how much storage the user has allocated/consumed.
static java.lang.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 java.lang.String	DEFAULTADMINISTRATIONGROUP_ATTRIBUTE The DirectoryUser's default AdministrationGroup.
static java.lang.String	HOMEFOLDER_ATTRIBUTE The DirectoryUser's home folder.
static java.lang.String	LANGUAGE_ATTRIBUTE The DirectoryUser's language preference for document uploading.
static java.lang.String	LOCALE_ATTRIBUTE The DirectoryUser's locale preference.
static java.lang.String	READINDICATIONENABLED_ATTRIBUTE An indicator of whether read indication is enabled or disabled.
static java.lang.String	READINDICATIONSTATE_ATTRIBUTE An indicator of which documents' content the DirectoryUser has read.
static java.lang.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, ADMINISTRATIONGROUP_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKEDFORSESSION_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, LOCKSTATE_ATTRIBUTE, LOCKSTATE_HARDLOCK, LOCKSTATE_SESSIONLOCK, LOCKSTATE_SOFTLOCK, LOCKSTATE_UNLOCK, LOCKSTATE_USERLOCK, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE

Method Summary

java.lang.String	getCharacterSet() Retrieves the default character set setting used when uploading a document.
ContentQuota	getContentQuota() Gets the DirectoryUser's ContentQuota object.
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.
Folder	getHomeFolder() Gets the DirectoryUser's home folder.
java.lang.String	getLanguage() Retrieve the default language setting used when uploading a document.
java.util.Locale	getLocale() Retrieves the user preferred locale.
java.util.TimeZone	getTimeZone() Retrieves the user preferred time zone.
boolean	isReadIndicationEnabled() Determines whether read indication is enabled.
void	setCharacterSet(java.lang.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	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	setHomeFolder(Folder folder) Sets the DirectoryUser's home folder.
void	setLanguage(java.lang.String language) Sets the default language setting to use when uploading a document.
void	setLocale(java.util.Locale locale) Sets the user preferred locale.
void	setTimeZone(java.util.TimeZone timeZone) Sets the user preferred time zone.

Methods inherited from class oracle.ifs.beans.UserProfile

getDirectoryUser

Methods inherited from class oracle.ifs.beans.PublicObject

addCategory, addRelationship, checkEffectiveAccess, checkEffectiveAccess, copy, getAcl, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getCategories, getCategories, getCategories, getCategories, getCreateDate, getCreator, getDefaultAccessLevel, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFlags, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLockObject, getLockState, getLockStateLabel, getOwner, getPolicyBundle, getPropertyBundle, getResolvedPublicObject, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, grantAccess, handleEvent, hasNameAttribute, isLocked, isLockedForSession, isLockedForSessionByCurrentSession, isVersionable, isVersioned, lock, lock, lock, putPolicy, putProperty, putProperty, removeAllPolicies, removeAllProperties, removePolicy, removePolicy, removeProperty, removeRelationship, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setOwner, setPolicyBundle, setPropertyBundle, setSecuringPublicObject, toLockStateLabel, toLockStateLabel, toLockStateLabel, unlock, updateLock

Methods inherited from class oracle.ifs.beans.LibraryObject

equals, free, free, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getClassId, getClassObject, getDefinition, getId, getLabel, getName, getSession, invokeServerMethod, isInstanceOf, isTraced, lookupInstanceLabel, postEvent, postEvent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setName, toString, trace, update

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getId

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final java.lang.String CLASS_NAME

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

HOMEFOLDER_ATTRIBUTE

public static final java.lang.String HOMEFOLDER_ATTRIBUTE

The DirectoryUser's home folder.

DEFAULTACLS_ATTRIBUTE

public static final java.lang.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.

DEFAULTADMINISTRATIONGROUP_ATTRIBUTE

public static final java.lang.String DEFAULTADMINISTRATIONGROUP_ATTRIBUTE

The DirectoryUser's default AdministrationGroup.

READINDICATIONSTATE_ATTRIBUTE

public static final java.lang.String READINDICATIONSTATE_ATTRIBUTE

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

READINDICATIONENABLED_ATTRIBUTE

public static final java.lang.String READINDICATIONENABLED_ATTRIBUTE

An indicator of whether read indication is enabled or disabled.

CONTENTQUOTA_ATTRIBUTE

public static final java.lang.String CONTENTQUOTA_ATTRIBUTE

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

LANGUAGE_ATTRIBUTE

public static final java.lang.String LANGUAGE_ATTRIBUTE

The DirectoryUser's language preference for document uploading.

CHARACTERSET_ATTRIBUTE

public static final java.lang.String CHARACTERSET_ATTRIBUTE

The DirectoryUser's character set preference for document uploading.

LOCALE_ATTRIBUTE

public static final java.lang.String LOCALE_ATTRIBUTE

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

TIMEZONE_ATTRIBUTE

public static final java.lang.String TIMEZONE_ATTRIBUTE

The DirectoryUser's time zone preference.

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

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

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

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

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

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

setLanguage

public void setLanguage(java.lang.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 language to use.

Throws:

IfsException - will be generated if the operation fails.

getLanguage

public java.lang.String getLanguage()
                             throws IfsException

Retrieve the default language setting used when uploading a document.

Returns:

Identifier code of the language being used.

Throws:

IfsException - will be generated if the operation fails.

setCharacterSet

public void setCharacterSet(java.lang.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 Java naming convention and not the Iana or Oracle name for character set values (i.e. ISO8859_1 is valid, ISO-8859-1 is invalid).

Parameters:

charSet - Identifier code of Java character set to use.

Throws:

IfsException - will be generated if the operation fails.

getCharacterSet

public java.lang.String getCharacterSet()
                                 throws IfsException

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

Returns:

Identifier code of the Java character set used.

Throws:

IfsException - will be generated if the operation fails.

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone)
                 throws IfsException

Sets the user preferred time zone.

Parameters:

timeZone - TimeZone which user would like to use.

Throws:

IfsException - will be generated if the operation fails.

getTimeZone

public java.util.TimeZone getTimeZone()
                               throws IfsException

Retrieves the user preferred time zone.

Returns:

TimeZone which user prefers to use.

Throws:

IfsException - will be generated if the operation fails.

setLocale

public void setLocale(java.util.Locale locale)
               throws IfsException

Sets the user preferred locale.

Parameters:

locale - User preferred locale setting.

Throws:

IfsException - will be generated if the operation fails.

getLocale

public java.util.Locale getLocale()
                           throws IfsException

Retrieves the user preferred locale.

Returns:

User preferred locale setting.

Throws:

IfsException - will be generated if the operation fails.

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