curam.sec.sef.application.facade.intf

Interface SocialEnterpriseFolderClient

All Known Implementing Classes:

SocialEnterpriseFolderClient, curam.sec.sef.application.facade.impl.SocialEnterpriseFolderClient, SocialEnterpriseFolderClientFactory

public interface SocialEnterpriseFolderClient

Facade layer class for maintaining SocialEnterpriseFolder Client details.

Method Summary

Modifier and Type	Method and Description
curam.core.facade.struct.GroupTabList	addMember(curam.sec.sef.application.facade.struct.SocialEnterpriseFolderAddMemberDetails dtls) Adds a participant to a Social Enterprise Folder.
curam.sec.sef.application.facade.struct.SocialEnterpriseFolderCurrentAndRemovedClientDetails	listCurrentAndRemovedMembersForSocialEnterpriseFolder(curam.sec.sef.application.entity.struct.SocialEnterpriseFolderKey key) Returns all participants ever added to a Social Enterprise Folder.
curam.sec.sef.application.facade.struct.SocialEnterpriseFolderClientList	listCurrentMembersForSocialEnterpriseFolder(curam.sec.sef.application.entity.struct.SocialEnterpriseFolderKey key) Returns the participants currently added to a Social Enterprise Folder.
curam.sec.sef.application.facade.struct.SocialEnterpriseFolderClientList	listMembersForSocialEnterpriseFolder(curam.sec.sef.application.entity.struct.SocialEnterpriseFolderKey key, curam.sec.sef.application.facade.struct.CurrentMembersOnly currentMembersOnly) Lists members for the Social Enterprise Folder, members can be filtered by the currentMembersOnly boolean.
curam.sec.sef.application.facade.struct.SocialEnterpriseFolderClientList	listRemovedMembersForSocialEnterpriseFolder(curam.sec.sef.application.entity.struct.SocialEnterpriseFolderKey key) Returns the participants that have been removed from a Social Enterprise Folder.
curam.sec.sef.application.facade.struct.ExternalPersonDetails	readExternalPerson(curam.sec.sef.application.facade.struct.ExternalPersonKey key) Deprecated. Since Curam 8.0.0.0 ClientAccess_Deprecation. This functionality forms part of a feature that is no longer relevant to the product strategy and will not be replaced. Reads the details of an external person. @param key The unique identifier of the external person to read @return The details of the external person
curam.sec.sef.application.facade.struct.SEFMemberFullDetails	readSEFMemberFullDetails(curam.core.struct.ConcernRoleID key) Reads SEF member data for the modal popup
void	removeMember(curam.sec.sef.application.facade.struct.SocialEnterpriseFolderAddMemberDetails dtls) Removes a participant from a Social Enterprise Folder.
curam.sec.sef.application.facade.struct.SocialEnterprisePersonSearchResult	searchForPerson(curam.core.facade.struct.PersonSearchKey key) Searches for a person using the specified criteria.
curam.sec.sef.application.facade.struct.SearchPotentialCasesForMemberListResultList	searchPotentialCasesForMemberList(curam.sec.sef.application.facade.struct.GroupTabList key) List cases where any of the members in the tabbedList are a participant on that case, where that case is not a SocialEnterpriseFolder itself, and where that case is not already on this SocialEnterpriseFolder.
curam.core.facade.struct.GroupTabList	validateAndFormatMemberList(curam.core.facade.struct.GroupTabList key) Parses and formats a participant tabbed list.

Method Detail

addMember

curam.core.facade.struct.GroupTabList addMember(curam.sec.sef.application.facade.struct.SocialEnterpriseFolderAddMemberDetails dtls)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

Adds a participant to a Social Enterprise Folder.

@param dtls The dtls of the member to be added

@return tabbed list of member added, needed for adding cases on client

@throws AppException

@throws InformationalException

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listCurrentAndRemovedMembersForSocialEnterpriseFolder

curam.sec.sef.application.facade.struct.SocialEnterpriseFolderCurrentAndRemovedClientDetails listCurrentAndRemovedMembersForSocialEnterpriseFolder(curam.sec.sef.application.entity.struct.SocialEnterpriseFolderKey key)
                                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                                   curam.util.exception.InformationalException

Returns all participants ever added to a Social Enterprise Folder.

@param key The Social Enterprise Folder

@return the list of current and removed Social Enterprise Folder members

@throws AppException

@throws InformationalException

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listCurrentMembersForSocialEnterpriseFolder

curam.sec.sef.application.facade.struct.SocialEnterpriseFolderClientList listCurrentMembersForSocialEnterpriseFolder(curam.sec.sef.application.entity.struct.SocialEnterpriseFolderKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Returns the participants currently added to a Social Enterprise Folder.

@param key The Social Enterprise Folder

@return the list of current Social Enterprise Folder members

@throws AppException

@throws InformationalException

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listRemovedMembersForSocialEnterpriseFolder

curam.sec.sef.application.facade.struct.SocialEnterpriseFolderClientList listRemovedMembersForSocialEnterpriseFolder(curam.sec.sef.application.entity.struct.SocialEnterpriseFolderKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Returns the participants that have been removed from a Social Enterprise Folder.

@param key The Social Enterprise Folder

@return the list of removed Social Enterprise Folder members

@throws AppException

@throws InformationalException

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

removeMember

void removeMember(curam.sec.sef.application.facade.struct.SocialEnterpriseFolderAddMemberDetails dtls)
           throws curam.util.exception.AppException,
                  curam.util.exception.InformationalException

Removes a participant from a Social Enterprise Folder.

@param dtls The dtls of the member being removed

@throws AppException

@throws InformationalException

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readSEFMemberFullDetails

curam.sec.sef.application.facade.struct.SEFMemberFullDetails readSEFMemberFullDetails(curam.core.struct.ConcernRoleID key)
                                                                               throws curam.util.exception.AppException,
                                                                                      curam.util.exception.InformationalException

Reads SEF member data for the modal popup

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchPotentialCasesForMemberList

curam.sec.sef.application.facade.struct.SearchPotentialCasesForMemberListResultList searchPotentialCasesForMemberList(curam.sec.sef.application.facade.struct.GroupTabList key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

List cases where any of the members in the tabbedList are a participant on that case, where that case is not a SocialEnterpriseFolder itself, and where that case is not already on this SocialEnterpriseFolder.

@param key tabbed list of SocialEnterpriseFolder members

@return SearchPotentialCasesForMemberListResultList case list

@throws AppException

@throws InformationalException

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

validateAndFormatMemberList

curam.core.facade.struct.GroupTabList validateAndFormatMemberList(curam.core.facade.struct.GroupTabList key)
                                                           throws curam.util.exception.AppException,
                                                                  curam.util.exception.InformationalException

Parses and formats a participant tabbed list.

@param key the list of pipe delimited members

@return tab delimited string of members

@throws AppException

@throws InformationalException

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listMembersForSocialEnterpriseFolder

curam.sec.sef.application.facade.struct.SocialEnterpriseFolderClientList listMembersForSocialEnterpriseFolder(curam.sec.sef.application.entity.struct.SocialEnterpriseFolderKey key,
                                                                                                              curam.sec.sef.application.facade.struct.CurrentMembersOnly currentMembersOnly)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Lists members for the Social Enterprise Folder, members can be filtered by the currentMembersOnly boolean.

@param key the SocialEnterpriseFolder currentMembersOnlyInd - current members or removed members

@return SocialEnterpriseFolderClientList the list of members

@throws AppException

@throws InformationalException

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchForPerson

curam.sec.sef.application.facade.struct.SocialEnterprisePersonSearchResult searchForPerson(curam.core.facade.struct.PersonSearchKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Searches for a person using the specified criteria.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readExternalPerson

@Deprecated
curam.sec.sef.application.facade.struct.ExternalPersonDetails readExternalPerson(curam.sec.sef.application.facade.struct.ExternalPersonKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Deprecated. Since Curam 8.0.0.0 ClientAccess_Deprecation. This functionality forms part of a feature that is no longer relevant to the product strategy and will not be replaced. Reads the details of an external person.

@param key The unique identifier of the external person to read

@return The details of the external person

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException