public class Community extends TieFolder
Modifier and Type | Field and Description |
---|---|
static String |
AUTOFOLDERINGSPEC_ATTRIBUTE
The auto-foldering policy used by this community.
|
static String |
CLASS_NAME
The name of the ClassObject representing this class.
|
static String |
COMMUNITY_ACTIVITYSPECIFICATION_NAME
The name of the ActivitySpecification to use for the ActivityRecord
on Community.
|
static String |
DEFAULT_AUTOFOLDERACTIONSPECIFICATION_NAME
The name of the default AutoFolderActionSpecification to use
when one is not specified explcitly.
|
static String |
INVITATION_ACTIVITYSPECIFICATION_NAME
The name of the ActivitySpecification to use for the ActivityRecord on
Invitations.
|
static String |
INVITATIONS_SUBFOLDER_NAME
The name to use for the sub-folder which contains the Invitations.
|
static String |
POSTING_ACTIVITYSPECIFICATION_NAME
The name of the ActivitySpecification to use for the ActivityRecord on
Postings.
|
static String |
POSTINGS_SUBFOLDER_NAME
The name to use for the sub-folder which contains the auto-foldered Postings.
|
static String |
REMOVEDPOSTINGS_SUBFOLDER_NAME
The name to use for the sub-folder which contains the removed Postings.
|
static String |
UNIQUENAME_ATTRIBUTE
The name that uniquely identifies this Community.
|
SYSTEMOPTIONVALUE_FOLDER_DEPTH_DEEPEST, SYSTEMOPTIONVALUE_FOLDER_DEPTH_MUST_BE_EMPTY, SYSTEMOPTIONVALUE_FOLDER_DEPTH_NONE
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
Constructor and Description |
---|
Community(LibrarySession session,
Long id,
Long classId,
S_LibraryObjectData data)
Construct a Community object.
|
Modifier and Type | Method and Description |
---|---|
Invitation |
addInvitation(InvitationDefinition inviteDef)
Add an Invitation to this Community.
|
CommunityMember |
addMember(Actor actor)
Add a member to a Community.
|
Posting |
addPosting(Document doc)
Add a Posting to this Community.
|
Posting |
addPosting(DocumentDefinition docDef)
Add a Posting to this Community.
|
void |
executeAddInvitationAction(Invitation invite)
Execute an "Add Invitation" action to reflect the addition of a new Invitation.
|
void |
executeAddMemberAction(CommunityMember mem)
Execute a "Member added" action to reflect adding a member
to the Community.
|
void |
executeAddPostingAction(Posting posting)
Execute an "Add Posting" action to reflect the addition of a new Posting.
|
void |
executeCreatedAction()
Execute a "Created" action to reflect the creation of the ActivityRecord -
essentially capturing the Actor who created this Community.
|
void |
executeRecommendMembershipAction(Actor recActor,
String comment)
Execute a "Recommend Membership" action to reflect recommending membership
to the Community to the specified Actor.
|
void |
executeRemoveMemberAction(CommunityMember mem)
Execute a "Member removed" action to reflect adding a member
to the Community.
|
void |
executeRemovePostingAction(Posting posting)
Execute a "Remove Posting" action to reflect the removal of a Posting.
|
void |
executeUpdateInvitationAction(Invitation invite)
Execute an "Update Invitation" action to reflect the update of an Invitation.
|
static Community[] |
findAll(LibrarySession session)
Returns the set of all Community instances that the user has access to.
|
static Community |
findByUniqueName(LibrarySession session,
String uniqueName)
Returns the a Community matching the specified uniquename.
|
Conversation |
findConversation(Actor[] actors)
Find a Conversation within the Community with exactly the specified set of
participants.
|
Invitation |
findInvitation(String inviteName)
Returns the Invitation instance that matches the specified name.
|
CommunityMember |
findMemberByActor(Actor actor)
Find a member of the Community by a specified Actor.
|
Posting |
findPosting(String postingName)
Returns the Posting instance that matches the specified name.
|
AutoFolderingActionSpecification |
getAutoFolderingActionSpec()
Gets the AutoFolderingActionSpecification used by this instance.
|
Invitation[] |
getInvitations()
Gets the Invitations contained within this Community.
|
Invitation[] |
getInvitations(String sortClause)
Gets the Invitations contained within this Community.
|
Folder |
getInvitationsSubfolder()
Gets the subfolder which contains the Invitations.
|
CommunityMember[] |
getMembers()
Get the members of the Community.
|
Posting[] |
getPostings()
Gets the Postings contained within this Community.
|
Posting[] |
getPostings(String sortClause)
Gets the Postings contained within this Community.
|
Folder |
getPostingsSubfolder()
Gets the subfolder which contains the Auto-foldered Postings.
|
Posting[] |
getRemovedPostings()
Gets the Postings that have been removed from this Community.
|
Folder |
getRemovedPostingsSubfolder()
Gets the subfolder which contains the Postings that were removed.
|
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.
|
void |
recommendMembership(Actor recActor,
String comment)
Recommend membership in a Community to another Actor.
|
void |
removeMember(CommunityMember mem)
Remove a member from a Community.
|
void |
removePosting(Posting posting)
Add a Posting to this Community.
|
Conversation |
startConversation(String name,
Actor[] actors)
Start a Conversation with community members
|
addItem, addItem, addItems, auditUpdated, capabilities, checkExistenceOfPublicObjectByPath, constructFolder, constructFolderArray, constructFolderVector, createSecuredDocument, createUniqueName, createUniqueName, deepFree, exists, fetchItemCount, fetchSubfolderCount, find, findPublicObjectByPath, free, getGlobalAuditEventExpirationPeriod, getGlobalAuditTypeList, getItemCount, getItems, getResolvedItems, getSortSpecification, getSubfolderCount, handleAdminModeChange, handleDefaultFolderOptionChange, handleEvent, hasItems, hasSubfolders, initializeSubfolderIndication, isAuditAdministrator, isValidEventType, isValidNameForNewObject, lock, lock, moveItems, newGetItems, preFree, removeAllItems, removeItem, removeItem, removeItems, reportFolderCreated, reportFolderFreed, reportFolderItemAdded, reportFolderItemRemoved, resetItems, resolveSortSpecification, setDomainVisibleSecurity, setSortSpecification, unlock, vectorToFolderArray, verifyAddItemCapability, verifyRemoveItemCapability, verifyValidAuditDomain
addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, auditPublicObjectLocked, auditPublicObjectUnlocked, 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, 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, postSecurityChangedEvent, postUpdate, preCopy, 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, 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, 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
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 UNIQUENAME_ATTRIBUTE
public static final String AUTOFOLDERINGSPEC_ATTRIBUTE
public static final String DEFAULT_AUTOFOLDERACTIONSPECIFICATION_NAME
public static final String COMMUNITY_ACTIVITYSPECIFICATION_NAME
public static final String POSTING_ACTIVITYSPECIFICATION_NAME
public static final String INVITATION_ACTIVITYSPECIFICATION_NAME
public static final String POSTINGS_SUBFOLDER_NAME
public static final String REMOVEDPOSTINGS_SUBFOLDER_NAME
public static final String INVITATIONS_SUBFOLDER_NAME
public Community(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) throws IfsException
session
- current LibrarySessionid
- object idclassId
- class iddata
- data componentIfsException
- if the operation failspublic AutoFolderingActionSpecification getAutoFolderingActionSpec() throws IfsException
IfsException
- if operation failspublic Folder getPostingsSubfolder() throws IfsException
IfsException
- if operation failspublic Folder getRemovedPostingsSubfolder() throws IfsException
IfsException
- if operation failspublic Folder getInvitationsSubfolder() throws IfsException
IfsException
- if operation failspublic Posting[] getPostings() throws IfsException
IfsException
- if operation failspublic Posting[] getPostings(String sortClause) throws IfsException
sortClause
- the Sort clauseIfsException
- if operation failspublic Posting[] getRemovedPostings() throws IfsException
IfsException
- if operation failspublic Invitation[] getInvitations() throws IfsException
IfsException
- if operation failspublic Invitation[] getInvitations(String sortClause) throws IfsException
sortClause
- the Sort clauseIfsException
- if operation failsprotected void preCreate(LibraryObjectDefinition lodef) throws IfsException
Set an option that indicates that Categories are NOT to be created from within S_PublicObject.
preCreate
in class PublicObject
lodef
- object definition that will be used to create
the objectIfsException
- if the operation failsprotected void postCreate(LibraryObjectDefinition lodef) throws IfsException
This assumes that a transaction context has already been established.
postCreate
in class Folder
lodef
- object definition that was used to create the objectIfsException
- if the operation failspublic Invitation addInvitation(InvitationDefinition inviteDef) throws IfsException
inviteDef
- the InvitationDefinition to addIfsException
- if operation failspublic Posting addPosting(DocumentDefinition docDef) throws IfsException
docDef
- the Document definition for the first versionIfsException
- if operation failspublic Posting addPosting(Document doc) throws IfsException
doc
- the Document to use for the first versionIfsException
- if operation failspublic void removePosting(Posting posting) throws IfsException
posting
- the Posting to remove from the CommunityIfsException
- if operation failspublic CommunityMember addMember(Actor actor) throws IfsException
actor
- the Actor to addIfsException
- if the operation failspublic void removeMember(CommunityMember mem) throws IfsException
mem
- the CommunityMember that reflects the
membership to removeIfsException
- if the operation failspublic CommunityMember[] getMembers() throws IfsException
IfsException
- if the operation failspublic CommunityMember findMemberByActor(Actor actor) throws IfsException
actor
- the Actor to look forIfsException
- if the operation failspublic Conversation startConversation(String name, Actor[] actors) throws IfsException
name
- the Conversation nameactors
- the participating Actors; all must be
members of the CommunityIfsException
- if operation failspublic Conversation findConversation(Actor[] actors) throws IfsException
Assumes that the specifies set of Actors do not contain duplicates.
actors
- the participating Actors; all must be
members of the CommunityIfsException
- if operation failspublic void recommendMembership(Actor recActor, String comment) throws IfsException
recActor
- the Actor that should receive notification of the
membership recommendationcomment
- the comment that should accompany the recommendationIfsException
- if operation failspublic void executeCreatedAction() throws IfsException
IfsException
- if operation failspublic void executeAddPostingAction(Posting posting) throws IfsException
posting
- the new PostingIfsException
- if operation failspublic void executeRemovePostingAction(Posting posting) throws IfsException
posting
- the Posting that was removedIfsException
- if operation failspublic void executeAddMemberAction(CommunityMember mem) throws IfsException
mem
- the CommunityMember that was added to reflect
the new membershipIfsException
- if operation failspublic void executeRemoveMemberAction(CommunityMember mem) throws IfsException
mem
- the CommunityMember that was added to reflect
the new membershipIfsException
- if operation failspublic void executeRecommendMembershipAction(Actor recActor, String comment) throws IfsException
recActor
- the Actor that should receive notification of the
membership recommendationcomment
- the comment that should accompany the recommendationIfsException
- if operation failspublic void executeAddInvitationAction(Invitation invite) throws IfsException
invite
- the new InvitationIfsException
- if operation failspublic void executeUpdateInvitationAction(Invitation invite) throws IfsException
invite
- the Invitation to updateIfsException
- if operation failspublic static Community[] findAll(LibrarySession session) throws IfsException
The instances will be sorted by uniquename.
session
- the session contextIfsException
- if the operation fails.public static Community findByUniqueName(LibrarySession session, String uniqueName) throws IfsException
Community names are case sensitive, so this operations requires an exact match with respect to case.
session
- the session contextuniqueName
- the Community UniqueNameIfsException
- if the operation fails.public Posting findPosting(String postingName) throws IfsException
If more than one instance exists with the same name, the oldest one is returned.
postingName
- the name of the PostingIfsException
- if the operation fails.public Invitation findInvitation(String inviteName) throws IfsException
If more than one instance exists with the same name, the oldest one is returned.
inviteName
- the name of the InvitationIfsException
- if the operation fails.Copyright © 2023. All rights reserved.