oracle.ifs.beans

Class MessageEntry

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.Document

oracle.ifs.beans.TieDocument

oracle.ifs.beans.MessageEntry

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

Direct Known Subclasses:

TieMessageEntry

public class MessageEntry
extends TieDocument

A MessageEntry reflects a single message within a MessageList.

Author:

Oskar Wetterstein

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME
static String	MESSAGELIST_ATTRIBUTE The MessageList to which this message belongs.
static String	MESSAGETEXT_ATTRIBUTE The message text.
static String	REFERENCEDMESSAGEENTRY_ATTRIBUTE The referenced MessageEntry.

Fields inherited from class oracle.ifs.beans.Document

CONTENTOBJECT_ATTRIBUTE, CONTENTQUOTA_ATTRIBUTE, INITIALLIFECYCLEDATE_ATTRIBUTE, LIFECYCLEDATE_ATTRIBUTE, LIFECYCLEPOLICY_ATTRIBUTE, LIFECYCLEPOLICYENTRYID_ATTRIBUTE, LIFECYCLEPOLICYID_ATTRIBUTE, READBYOWNER_ATTRIBUTE, RETENTIONPOLICY_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

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

Method Summary

Modifier and Type	Method and Description
protected static MessageEntry[]	constructMessageEntryArray(LibrarySession sess, Long[] ids) Constructs a MessageEntry array from an array of object IDs.
MessageList	getMessageList() Gets the encapsulating MessageList.
String	getMessageText() Gets the message text.
MessageEntry	getReferencedMessageEntry() Gets the MessageEntry referenced by this instance, for example, to indicate a reply to another MessageEntry within the same MessageList.
protected boolean	isValidEventType(AuditEvent event) Checks to see if the event type in the process of being posted on the target LibraryObject is consistent with the target.
protected void	postCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the creation of a PublicObject.
protected void	preCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the creation of a PublicObject.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
protected void	preUpdate(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the update of a PublicObject.

Methods inherited from class oracle.ifs.beans.Document

auditContentRead, auditLifecyclePolicyCleared, auditLifecyclePolicySet, auditLifecycleStateUpdated, auditPublicObjectLocked, auditPublicObjectUnlocked, auditRetentionPolicyCleared, auditRetentionPolicySet, auditUpdated, capabilities, constructDocument, constructDocumentVector, filterContent, generateFilename, generateSummary, generateThemes, getCharacterSet, getClassId, getContentByRandomAccess, getContentModificationDate, getContentObject, getContentQuota, getContentReader, getContentRowId, getContentSize, getContentStream, getCurrentLifecyclePolicyEntry, getFilteredContent, getFormat, getInitialLifecycleDate, getLanguage, getLifecycleDate, getLifecyclePolicy, getLifecycleState, getMedia, getMimeType, getNextLifecyclePolicyEntry, getRandomAccessContent, getRandomAccessContent, getRetentionPolicy, getSummary, getThemes, isBinaryFormat, isReadByOwner, isReadByUser, reportDocumentCreated, reportDocumentFreed, setCharacterSet, setContent, setContentQuota, setFormat, setLanguage, setLifecycleDate, setLifecyclePolicy, setReadByUser, setRetentionPolicy, updateContentByRandomAccess, vectorDocumentElement, vectorToDocumentArray, verifyContentObject

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, 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, 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, postSecurityChangedEvent, postUpdate, preCopy, 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, 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, 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

See Also:

Constant Field Values

MESSAGELIST_ATTRIBUTE

public static final String MESSAGELIST_ATTRIBUTE

The MessageList to which this message belongs.

See Also:

Constant Field Values

MESSAGETEXT_ATTRIBUTE

public static final String MESSAGETEXT_ATTRIBUTE

The message text.

See Also:

Constant Field Values

REFERENCEDMESSAGEENTRY_ATTRIBUTE

public static final String REFERENCEDMESSAGEENTRY_ATTRIBUTE

The referenced MessageEntry.

See Also:

Constant Field Values

Constructor Detail

MessageEntry

public MessageEntry(LibrarySession session,
                    Long id,
                    Long classId,
                    S_LibraryObjectData data)
             throws IfsException

Constructs a MessageEntry.

Parameters:

session - the session

id - the id

classId - the class id

data - the data

Throws:

IfsException

Method Detail

getMessageList

public MessageList getMessageList()
                           throws IfsException

Gets the encapsulating MessageList.

Overrides:

getMessageList in class PublicObject

Returns:

the parent MessageList

Throws:

IfsException - if operation fails

getMessageText

public String getMessageText()
                      throws IfsException

Gets the message text.

Returns:

the message text

Throws:

IfsException - if operation fails

getReferencedMessageEntry

public MessageEntry getReferencedMessageEntry()
                                       throws IfsException

Gets the MessageEntry referenced by this instance, for example, to indicate a reply to another MessageEntry within the same MessageList.

Returns:

the referenced MessageEntry

Throws:

IfsException - if operation fails

preCreate

protected void preCreate(LibraryObjectDefinition lodef)
                  throws IfsException

Extensibility point to perform actions prior to the creation of a PublicObject.

Set an option that indicates that Categories are NOT to be created from within S_PublicObject.

Overrides:

preCreate in class Document

Parameters:

lodef - object definition that will be used to create the object

Throws:

IfsException - if the operation fails

postCreate

protected void postCreate(LibraryObjectDefinition lodef)
                   throws IfsException

Extensibility point to perform actions after the creation of a PublicObject.

This assumes that a transaction context has already been established.

Overrides:

postCreate in class Document

Parameters:

lodef - object definition that was used to create the object

Throws:

IfsException - if the operation fails

preUpdate

protected void preUpdate(LibraryObjectDefinition lodef)
                  throws IfsException

Extensibility point to perform actions prior to the update of a PublicObject.

Set an option that indicates that Categories are NOT to be created from within S_PublicObject.

Overrides:

preUpdate in class Document

Parameters:

lodef - object definition used to define how the target object will be updated

Throws:

IfsException - if operation fails.

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

Description copied from class: PublicObject

Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

Override to free all existing categories, in such a way that the PO doesn't get updated for each category free.

Overrides:

preFree in class Document

Parameters:

lodef - object definition used to hold options related to the free operation

Throws:

IfsException - if operation fails.

isValidEventType

protected boolean isValidEventType(AuditEvent event)
                            throws IfsException

Checks to see if the event type in the process of being posted on the target LibraryObject is consistent with the target.

Overrides:

isValidEventType in class Document

Parameters:

event - the event being posted on this object

Returns:

true if the type is consistent; false otherwise

Throws:

IfsException - if the operation fails

constructMessageEntryArray

protected static MessageEntry[] constructMessageEntryArray(LibrarySession sess,
                                                           Long[] ids)
                                                    throws IfsException

Constructs a MessageEntry array from an array of object IDs.

This will throw an exception if any of the IDs cannot be converted into a MessageEntry object.

Parameters:

sess - the session

ids - the array of object IDs

Returns:

the array of MessageEntry instances

Throws:

IfsException - if operation fails.