public class PrimaryUserProfile extends TieUserProfile
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.
|
DIRECTORYUSER_ATTRIBUTE
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
DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session
Modifier | Constructor and Description |
---|---|
protected |
PrimaryUserProfile(LibrarySession session,
Long id,
Long classId,
S_LibraryObjectData data)
Constructs a PrimaryUserProfile.
|
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.
|
constructUserProfile, constructUserProfileVector, getDirectoryUser
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, 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
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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getAttributeByUpperCaseName, getClassId, getId, getSessionInterface
getTraceLogger, isTraced, trace
public static final String CLASS_NAME
public static final String HOMEFOLDER_ATTRIBUTE
public static final String DEFAULTACLS_ATTRIBUTE
public static final String READINDICATIONSTATE_ATTRIBUTE
public static final String READINDICATIONENABLED_ATTRIBUTE
public static final String CONTENTQUOTA_ATTRIBUTE
public static final String LANGUAGE_ATTRIBUTE
public static final String CHARACTERSET_ATTRIBUTE
public static final String LOCALE_ATTRIBUTE
public static final String TIMEZONE_ATTRIBUTE
public static final String DISPLAYNAME_ATTRIBUTE
public static final String EMAILADDRESS_ATTRIBUTE
protected PrimaryUserProfile(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) throws IfsException
session
- the sessionid
- the idclassId
- the class iddata
- data componentIfsException
- if the operation failspublic Folder getHomeFolder() throws IfsException
IfsException
- if the operation failspublic void setHomeFolder(Folder folder) throws IfsException
folder
- the Folder that will be the home folderIfsException
- if the operation failspublic ContentQuota getContentQuota() throws IfsException
IfsException
- if the operation failspublic void setContentQuota(ContentQuota quota) throws IfsException
quota
- the DirectoryUser's ContentQuotaIfsException
- if the operation failspublic PropertyBundle getDefaultAcls() throws IfsException
IfsException
- if the operation failspublic void setDefaultAcls(PropertyBundle props) throws IfsException
props
- PropertyBundle containing default ACLs
keyed by class nameIfsException
- if the operation failspublic AccessControlList getDefaultAcl() throws IfsException
IfsException
- if the operation failspublic void setDefaultAcl(AccessControlList acl) throws IfsException
acl
- a valid ACL objectIfsException
- if the operation failspublic void putDefaultAcl(String className, AccessControlList acl) throws IfsException
className
- name of the classacl
- a valid ACL objectIfsException
- if the operation failspublic void setLanguage(String language) throws IfsException
language
- Identifier code of Oracle language to use.IfsException
- if the operation fails.public String getLanguage() throws IfsException
IfsException
- if the operation fails.public void setCharacterSet(String charSet) throws IfsException
charSet
- Identifier code of Iana character set to use.IfsException
- if the operation fails.public String getCharacterSet() throws IfsException
IfsException
- if the operation fails.public void setTimeZone(TimeZone timeZone) throws IfsException
timeZone
- TimeZone which user would like to use.IfsException
- if the operation fails.public TimeZone getTimeZone() throws IfsException
IfsException
- if the operation fails.public void setLocale(Locale locale) throws IfsException
locale
- User preferred locale setting.IfsException
- if the operation fails.public Locale getLocale() throws IfsException
IfsException
- if the operation fails.public void setDisplayName(String name) throws IfsException
name
- Display name of the DirectoryUserIfsException
- if the operation fails.public String getDisplayName() throws IfsException
IfsException
- if the operation fails.public void setEmailAddress(String email) throws IfsException
email
- Email address for the DirectoryUserIfsException
- if the operation fails.public String getEmailAddress() throws IfsException
IfsException
- if the operation fails.public void removeDefaultAcl(String className) throws IfsException
className
- name of the classIfsException
- if the operation failspublic void removeAllDefaultAcls() throws IfsException
IfsException
- if the operation failspublic static PrimaryUserProfile[] findByHomeFolder(Folder folder) throws IfsException
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.
folder
- the home folderIfsException
- if the operation fails.protected static Vector constructPrimaryUserProfileVector(LibrarySession sess, Vector vector) throws IfsException
sess
- current LibrarySessionvector
- vector of LibraryObjectData objectsIfsException
- if the operation failsprotected static PrimaryUserProfile constructPrimaryUserProfile(LibrarySession sess, S_LibraryObjectData data) throws IfsException
sess
- current LibrarySessiondata
- data componentIfsException
- if the operation failspublic boolean isReadIndicationEnabled() throws IfsException
IfsException
- if the operation failspublic void setReadIndicationEnabled(boolean enable) throws IfsException
enable
- true if read indication should be effective.IfsException
- if the operation failsCopyright © 2023. All rights reserved.