oracle.ifs.beans

Class Conversation

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.ApplicationObject

oracle.ifs.beans.TieApplicationObject

oracle.ifs.beans.Conversation

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

Direct Known Subclasses:

TieConversation

public class Conversation
extends TieApplicationObject

A Conversation is used to manage the information comprising a semi-private communication between one or more Actors.

Author:

Dave Long

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	DEFAULT_ACTIVITYSPECIFICATION_NAME The name of the ActivitySpecification to use for Conversations.
static String	PARTICIPANTGROUP_ATTRIBUTE The name of the attribute that holds a group representing the DirectoryUsers corresponding to the Actors who are listed as participants in this Conversation.
static String	PARTICIPANTS_ATTRIBUTE The name of the attribute that holds a group representing the Actors who are included in this Conversation.

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	Conversation(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a Conversation object.

Method Summary

Modifier and Type	Method and Description
MessageEntry	addMessage(String message, String meName) Add a Message to this Conversation.
void	executeCreatedAction() Execute a "Created" action to reflect the creation of the ActivityRecord - essentially capturing the Actor who initiated this Conversation.
DirectoryGroup	getParticipantGroup() Gets the group representing the DirectoryUsers corresponding to the Actors who are listed as participants in this Conversation.
Actor[]	getParticipants() Gets the Actors who are listed as participants in this Conversation.
static Conversation	getTargetConversation(ActivityRecord ar) Gets the Conversation that is the target of the specified ActivityRecord.
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.ApplicationObject

auditPublicObjectLocked, auditPublicObjectUnlocked, auditUpdated, constructApplicationObject, constructApplicationObjectVector, isValidEventType, reportApplicationObjectCreated, reportApplicationObjectFreed

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, 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, 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

The name of the ClassObject representing this class.

See Also:

Constant Field Values

(Published)

PARTICIPANTGROUP_ATTRIBUTE

public static final String PARTICIPANTGROUP_ATTRIBUTE

The name of the attribute that holds a group representing the DirectoryUsers corresponding to the Actors who are listed as participants in this Conversation. (DirectoryObject)

See Also:

Constant Field Values

PARTICIPANTS_ATTRIBUTE

public static final String PARTICIPANTS_ATTRIBUTE

The name of the attribute that holds a group representing the Actors who are included in this Conversation. (DirectoryObject)

See Also:

Constant Field Values

DEFAULT_ACTIVITYSPECIFICATION_NAME

public static final String DEFAULT_ACTIVITYSPECIFICATION_NAME

The name of the ActivitySpecification to use for Conversations.

See Also:

Constant Field Values

Constructor Detail

Conversation

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

Construct a Conversation object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

getParticipants

public Actor[] getParticipants()
                        throws IfsException

Gets the Actors who are listed as participants in this Conversation.

Returns:

the participating Actors

Throws:

IfsException - if operation fails

getParticipantGroup

public DirectoryGroup getParticipantGroup()
                                   throws IfsException

Gets the group representing the DirectoryUsers corresponding to the Actors who are listed as participants in this Conversation.

Returns:

group of users corresponding to the included Actors

Throws:

IfsException - if operation fails

getTargetConversation

public static Conversation getTargetConversation(ActivityRecord ar)
                                          throws IfsException

Gets the Conversation that is the target of the specified ActivityRecord.

Parameters:

ar - the ActivityRecord

Returns:

the target Conversation

Throws:

IfsException - if operation fails

(Published)

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 PublicObject

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 ApplicationObject

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 PublicObject

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

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 ApplicationObject

Parameters:

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

Throws:

IfsException - if operation fails.

addMessage

public MessageEntry addMessage(String message,
                               String meName)
                        throws IfsException

Add a Message to this Conversation.

Parameters:

message - the text to use for the new message

meName - the name to use for the new MessageEntry

Returns:

the newly created MessageEntry

Throws:

IfsException - if operation fails

(Published)

executeCreatedAction

public void executeCreatedAction()
                          throws IfsException

Execute a "Created" action to reflect the creation of the ActivityRecord - essentially capturing the Actor who initiated this Conversation.

Throws:

IfsException - if operation fails