no.ubicollab.osgi.service.collaboration
Interface CollaborationService

All Known Implementing Classes:
CollaborationImpl

public interface CollaborationService

An interface for the Collaboration Service. Provides collaboration instance access to applications and other devices through web service calls.

Since:
0.9
Version:
0.9
Author:
Christian H. Mosveen

Method Summary
 boolean addPersonToCollabInst(java.lang.String collabInstId, java.lang.String username)
          Adds a specified person to the specified collaboration instance
 boolean addResourceToCollabInst(java.lang.String collabInstId, java.lang.String descriptionUrl, java.lang.String username, java.lang.String appName, java.lang.String fileName)
           
 boolean addServiceToCollabInst(java.lang.String collabInstId, java.lang.String descriptionUrl)
          Adds a specified service to the specified collaboration instance
 java.lang.String createCollaborationInstance(java.lang.String username, java.lang.String collabInstName)
          Creates a collaboration instance with the specified collabInstName, and where the creator is specified by username.
 java.lang.String[] getAllCollaborationInstances()
          Gets a list of all registered collaboration instances
 java.lang.String[] getAllPersons()
          Gets a list of all registered persons
 java.lang.String[] getAllPersonsInCollabInst(java.lang.String collabInstId)
          Gets a list of all persons in the specified collaboration instance
 java.lang.String[] getAllServices()
          Gets a list of all registered services
 java.lang.String[] getAllServicesInCollabInst(java.lang.String collabInstId)
          Gets a list of all services in the specified collaboration instance
 java.lang.String getCollabInstName(java.lang.String collabInstId)
          Gets the name of the specified collaboration instance
 java.lang.String[] getInfoAboutService(java.lang.String url)
          Gets all registered information about the specified service
 java.lang.String getPersonsFullName(java.lang.String username)
          Gets the full name of the specified person
 boolean removeCollaborationInstance(java.lang.String collabInstId, java.lang.String username)
          Removes a specified collaboration instance, if the username specified matches the collaboration instance's owner.
 boolean removePersonFromCollabInst(java.lang.String collabInstId, java.lang.String username)
          Removes a specified person from the specified collaboration instance
 boolean removeResourceFromCollabInst(java.lang.String collabInstId, java.lang.String descriptionUrl, java.lang.String username, java.lang.String appName, java.lang.String fileName)
           
 boolean removeServiceFromCollabInst(java.lang.String collabInstId, java.lang.String descriptionUrl)
          Removes a specified service from the specified collaboration instance
 

Method Detail

createCollaborationInstance

java.lang.String createCollaborationInstance(java.lang.String username,
                                             java.lang.String collabInstName)
Creates a collaboration instance with the specified collabInstName, and where the creator is specified by username.

Parameters:
username - The username of the collaboration instance's creator
collabInstName - The name of the collaboration instance to create
Returns:
A unique hash representing the collab inst id

removeCollaborationInstance

boolean removeCollaborationInstance(java.lang.String collabInstId,
                                    java.lang.String username)
Removes a specified collaboration instance, if the username specified matches the collaboration instance's owner.

Parameters:
collabInstId - The id of the collaboration instance to remove
username - The username of the person calling the method
Returns:
True if the specified collab inst was removed, false otherwise

addPersonToCollabInst

boolean addPersonToCollabInst(java.lang.String collabInstId,
                              java.lang.String username)
Adds a specified person to the specified collaboration instance

Parameters:
collabInstId - The id of the collaboration instance to add to
username - The username of the person to add
Returns:
True if the person was added to the collab inst, false otherwise

removePersonFromCollabInst

boolean removePersonFromCollabInst(java.lang.String collabInstId,
                                   java.lang.String username)
Removes a specified person from the specified collaboration instance

Parameters:
collabInstId - The id of the collaboration instance to remove from
username - The username of the person to remove
Returns:
True if the person was removed from the collab inst, false otherwise

addServiceToCollabInst

boolean addServiceToCollabInst(java.lang.String collabInstId,
                               java.lang.String descriptionUrl)
Adds a specified service to the specified collaboration instance

Parameters:
collabInstId - The id of the collaboration instance to add to
descriptionUrl - The descriptionUrl of the service to add
Returns:
True if the service was added to the collab inst, false otherwise

removeServiceFromCollabInst

boolean removeServiceFromCollabInst(java.lang.String collabInstId,
                                    java.lang.String descriptionUrl)
Removes a specified service from the specified collaboration instance

Parameters:
collabInstId - The id of the collaboration instance to remove from
descriptionUrl - The descriptionUrl of the service to remove
Returns:
True if the service was removed from the collab inst, false otherwise

addResourceToCollabInst

boolean addResourceToCollabInst(java.lang.String collabInstId,
                                java.lang.String descriptionUrl,
                                java.lang.String username,
                                java.lang.String appName,
                                java.lang.String fileName)
Parameters:
collabInstId -
descriptionUrl -
username -
appName -
fileName -
Returns:

removeResourceFromCollabInst

boolean removeResourceFromCollabInst(java.lang.String collabInstId,
                                     java.lang.String descriptionUrl,
                                     java.lang.String username,
                                     java.lang.String appName,
                                     java.lang.String fileName)
Parameters:
collabInstId -
descriptionUrl -
username -
appName -
fileName -
Returns:

getAllCollaborationInstances

java.lang.String[] getAllCollaborationInstances()
Gets a list of all registered collaboration instances

Returns:
A String[] with the id's of all registered collaboration instances

getAllPersons

java.lang.String[] getAllPersons()
Gets a list of all registered persons

Returns:
A String[] with the usernames of all registered persons

getAllServices

java.lang.String[] getAllServices()
Gets a list of all registered services

Returns:
A String[] with the descriptionUrl's of all registered services

getAllPersonsInCollabInst

java.lang.String[] getAllPersonsInCollabInst(java.lang.String collabInstId)
Gets a list of all persons in the specified collaboration instance

Parameters:
collabInstId - The id of the collaboration instance
Returns:
A String[] with the usernames of all persons in the collaboration instance

getAllServicesInCollabInst

java.lang.String[] getAllServicesInCollabInst(java.lang.String collabInstId)
Gets a list of all services in the specified collaboration instance

Parameters:
collabInstId - The id of the collaboration instance
Returns:
A String[] with the descriptionUrl's of all services in the collaboration instance

getCollabInstName

java.lang.String getCollabInstName(java.lang.String collabInstId)
Gets the name of the specified collaboration instance

Parameters:
collabInstId - The id of the collaboration instance
Returns:
The name of the collaboration instance

getPersonsFullName

java.lang.String getPersonsFullName(java.lang.String username)
Gets the full name of the specified person

Parameters:
username - The person's username
Returns:
The person's full name

getInfoAboutService

java.lang.String[] getInfoAboutService(java.lang.String url)
Gets all registered information about the specified service

Parameters:
url - The descriptionUrl of the service
Returns:
A String[] with a length of 10, with the fields: dbId, tagId, uuId, name, type, protocol, descriptionUrl, serviceUrl, owner, discovered.