Skip navigation links

oracle.webcenter.peopleconnections.connections
Interface ConnectionListsManager

public interface ConnectionListsManager

The access point for operations related to retrieving and updating information about connection lists and membership of users in these connection lists.

An instance of this can be obtained via a call to ConnectionsServiceFactory.getConnectionListsManager().

Since:

release specific (what release of product did this appear in)

Method Summary

void	addConnectionListListener(ConnectionListListener listener) Registers all the ConnectionListListeners to an arraylist of ConnectionListListener.
void	addMembersToConnectionList(java.util.List<java.lang.String> userGuids, java.lang.String listName) Adds the specified users as members to a specified connection list belonging to the current user.
void	createConnectionList(java.lang.String listName) Creates a connection list for the current user.
void	deleteConnectionList(java.lang.String listName) Destroys a specified connection list belonging to the current user.
java.util.List<ConnectionListListener>	getAllConnectionListListeners() Returns the list of ConnectionListListeners
ConnectionList	getConnectionList(java.lang.String listName, java.lang.String userGuid) Returns a specified connection list belonging to the specified user.
java.util.List<ConnectionList>	getConnectionLists(java.lang.String userGuid) Returns the connection lists belonging to the specified user.
java.util.List<java.lang.Object[]>	getConnectionsWithPreferences(java.util.List<java.lang.String> listNames, java.lang.String userGuid, java.lang.String applicationId, java.lang.String scope, java.lang.String serviceId, java.lang.String settingKey, java.lang.String configurableSettingKey) Returns the specified user's connection list's, the specified user', and the system's setting value for the specified setting key and the system's setting that indicates whether the specified setting is configurable by end user
java.util.List<java.lang.String>	getMemberConnectionListIds(java.lang.String memberGuid) Returns the ID's of the current user's connection lists to which a specified user belongs.
void	removeConnectionListListener(ConnectionListListener listener) Removes the ConnectionListListeners from the arraylist of ConnectionListListener.
void	removeFromAllConnectionLists(java.lang.String userGuid) Removes a specified user from all the connection lists maintained by the current user.
void	removeFromAllConnectionLists(java.lang.String userGuid, java.lang.String ownerGuid) Removes a specified user from all the connection lists maintained by the given owner user.
void	removeMemberFromConnectionList(java.lang.String userGuid, java.lang.String listName) Removes the specified user as a member from a specified connection list belonging to the current user.

Method Detail

addConnectionListListener

void addConnectionListListener(ConnectionListListener listener)
                               throws ConnectionsException

Registers all the ConnectionListListeners to an arraylist of ConnectionListListener.

Parameters:

object - of a class that implements ConnectionListListener

Throws:

ConnectionsException - If proper object of a class implementing ConnectionListListener is missing.

removeConnectionListListener

void removeConnectionListListener(ConnectionListListener listener)
                                  throws ConnectionsException

Removes the ConnectionListListeners from the arraylist of ConnectionListListener.

Parameters:

object - of a class that implements ConnectionListListener

Throws:

ConnectionsException - If proper object of a class implementing ConnectionListListener is missing.

getAllConnectionListListeners

java.util.List<ConnectionListListener> getAllConnectionListListeners()
                                                                     throws ConnectionsException

Returns the list of ConnectionListListeners

Parameters:

void -

Returns:

List containing all the instances of class implementing ConnectionListListener

Throws:

ConnectionsException - If some error arises while fetching instances of class implementing ConnectionListListener

getConnectionLists

java.util.List<ConnectionList> getConnectionLists(java.lang.String userGuid)
                                                  throws ConnectionsException

Returns the connection lists belonging to the specified user.

Parameters:

userGuid - GUID of a user in the system

Returns:

The list of objects representing the connection lists belonging to the specified user

Throws:

ConnectionsException - If the user GUID is null or any error occurs retrieving connection list information.

getConnectionList

ConnectionList getConnectionList(java.lang.String listName,
                                 java.lang.String userGuid)
                                 throws ConnectionsException

Returns a specified connection list belonging to the specified user.

Parameters:

listName - Name of a connection list belonging to the specified user

userGuid - GUID of a user in the system

Returns:

An object representing to the connection list with the specified name owned by the specified user

Throws:

ConnectionsException - If either the list name or the user GUID are null or any error occurs retrieving connection list information.

getConnectionsWithPreferences

java.util.List<java.lang.Object[]> getConnectionsWithPreferences(java.util.List<java.lang.String> listNames,
                                                                 java.lang.String userGuid,
                                                                 java.lang.String applicationId,
                                                                 java.lang.String scope,
                                                                 java.lang.String serviceId,
                                                                 java.lang.String settingKey,
                                                                 java.lang.String configurableSettingKey)
                                                                 throws ConnectionsException

Returns the specified user's connection list's, the specified user', and the system's setting value for the specified setting key and the system's setting that indicates whether the specified setting is configurable by end user

Parameters:

listNames - Name of a connection list belonging to the specified user

userGuid - GUID of the user for whom to return connections

applicationID - application ID used to lookup from the setting table

scope - scope used to lookup from the setting table

serviceId - service ID used to lookup from the setting table

settingKey - setting key to be looked up from the setting table

configurableSettingKey - system's setting key that indicates whether the specified seeting key can be configured by end user

Returns:

List of arrays of connection user guid, setting key, and setting value.

Throws:

ConnectionException - if the user guid is null or any error occurs retrieving Connections

ConnectionsException

getMemberConnectionListIds

java.util.List<java.lang.String> getMemberConnectionListIds(java.lang.String memberGuid)
                                                            throws ConnectionsException

Returns the ID's of the current user's connection lists to which a specified user belongs.

Parameters:

memberGuid - GUID of a user in the system

Returns:

List of ID's of connection lists belonging to the current user, in which the user referred by memberGuid is a member

Throws:

ConnectionsException - If the specified user GUID is null or any error occurs retrieving connection list information.

createConnectionList

void createConnectionList(java.lang.String listName)
                          throws ConnectionsException

Creates a connection list for the current user.

Parameters:

listName - A name for the connection list to be created

Throws:

ConnectionsException - If any error occurs creating the connetion list.

deleteConnectionList

void deleteConnectionList(java.lang.String listName)
                          throws ConnectionsException

Destroys a specified connection list belonging to the current user.

If the call to this method goes through successfully, all data associated with the connection list (e.g. information about which users were the members of the connection list) is destroyed.

Parameters:

listName - Name of the connection list to be destroyed

Throws:

ConnectionsException - If any error occurs removing the connection list from the system.

addMembersToConnectionList

void addMembersToConnectionList(java.util.List<java.lang.String> userGuids,
                                java.lang.String listName)
                                throws ConnectionsException

Adds the specified users as members to a specified connection list belonging to the current user.

Parameters:

userGuids - List of GUIDs of users to be added to the connection list

listName - Name of a connection list belonging to the current user

Throws:

ConnectionsException - If the specified connection list name is null or any error occurs adding the user as a member to the connection list.

removeMemberFromConnectionList

void removeMemberFromConnectionList(java.lang.String userGuid,
                                    java.lang.String listName)
                                    throws ConnectionsException

Removes the specified user as a member from a specified connection list belonging to the current user.

Parameters:

userGuid - GUID of a user who is a member of the connection list

listName - Name of a connection list belonging to the current user

Throws:

ConnectionsException - If either the user GUID or the name of the connection list are null, or any error occurs removing the user as a member from the connection list.

removeFromAllConnectionLists

void removeFromAllConnectionLists(java.lang.String userGuid)
                                  throws ConnectionsException

Removes a specified user from all the connection lists maintained by the current user.

This method removes the specified user from only the connection lists of the current user and does not remove the user as a connection, unlike ConnectionsManager.removeConnection(java.lang.String).

Parameters:

userGuid - GUID of the user to be removed

Throws:

ConnectionsException - If the user GUID is null or any error occurs while doing the remove.

removeFromAllConnectionLists

void removeFromAllConnectionLists(java.lang.String userGuid,
                                  java.lang.String ownerGuid)
                                  throws ConnectionsException

Removes a specified user from all the connection lists maintained by the given owner user.

This method removes the specified user from only the connection lists of the given user and does not remove the user as a connection, unlike ConnectionsManager.removeConnection(java.lang.String).

Parameters:

userGuid - GUID of the user to be removed

Throws:

ConnectionsException - If the user GUID is null or any error occurs while doing the remove.

Skip navigation links