public interface ConnectionListsManager
An instance of this can be obtained via a call to
ConnectionsServiceFactory.getConnectionListsManager()
.
Modifier and Type | Method and Description |
---|---|
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.
|
void addConnectionListListener(ConnectionListListener listener) throws ConnectionsException
object
- of a class that implements ConnectionListListenerConnectionsException
- If proper object of a class implementing
ConnectionListListener is missing.void removeConnectionListListener(ConnectionListListener listener) throws ConnectionsException
object
- of a class that implements ConnectionListListenerConnectionsException
- If proper object of a class implementing
ConnectionListListener is missing.java.util.List<ConnectionListListener> getAllConnectionListListeners() throws ConnectionsException
void
- ConnectionsException
- If some error arises while fetching instances of
class implementing ConnectionListListenerjava.util.List<ConnectionList> getConnectionLists(java.lang.String userGuid) throws ConnectionsException
userGuid
- GUID of a user in the systemConnectionsException
- If the user GUID is null
or any error occurs retrieving connection list information.ConnectionList getConnectionList(java.lang.String listName, java.lang.String userGuid) throws ConnectionsException
listName
- Name of a connection list belonging to the
specified useruserGuid
- GUID of a user in the systemConnectionsException
- If either the list name or the user GUID
are null
or any error occurs retrieving
connection list information.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
listNames
- Name of a connection list belonging to the specified useruserGuid
- GUID of the user for whom to return connectionsapplicationID
- application ID used to lookup from the setting tablescope
- scope used to lookup from the setting tableserviceId
- service ID used to lookup from the setting tablesettingKey
- setting key to be looked up from the setting tableconfigurableSettingKey
- system's setting key that indicates whether the
specified seeting key can be configured by end userConnectionException
- if the user guid is null or any error occurs
retrieving ConnectionsConnectionsException
java.util.List<java.lang.String> getMemberConnectionListIds(java.lang.String memberGuid) throws ConnectionsException
memberGuid
- GUID of a user in the systemmemberGuid
is a memberConnectionsException
- If the specified user GUID is null
or any error occurs retrieving connection list information.void createConnectionList(java.lang.String listName) throws ConnectionsException
listName
- A name for the connection list to be createdConnectionsException
- If any error occurs creating
the connetion list.void deleteConnectionList(java.lang.String listName) throws ConnectionsException
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.
listName
- Name of the connection list to be destroyedConnectionsException
- If any error occurs removing
the connection list from the system.void addMembersToConnectionList(java.util.List<java.lang.String> userGuids, java.lang.String listName) throws ConnectionsException
userGuids
- List of GUIDs of users to be added to the connection listlistName
- Name of a connection list belonging to the current userConnectionsException
- If the specified connection list name is
null
or any error occurs adding the user as a member to
the connection list.void removeMemberFromConnectionList(java.lang.String userGuid, java.lang.String listName) throws ConnectionsException
userGuid
- GUID of a user who is a member of the connection listlistName
- Name of a connection list belonging to the current userConnectionsException
- 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.void removeFromAllConnectionLists(java.lang.String userGuid) throws ConnectionsException
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)
.
userGuid
- GUID of the user to be removedConnectionsException
- If the user GUID is null
or any
error occurs while doing the remove.void removeFromAllConnectionLists(java.lang.String userGuid, java.lang.String ownerGuid) throws ConnectionsException
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)
.
userGuid
- GUID of the user to be removedConnectionsException
- If the user GUID is null
or any
error occurs while doing the remove.