org.gcube.personalization.userprofileaccess.impl
Class UserProfileAccessService

java.lang.Object
  extended by org.gcube.personalization.userprofileaccess.impl.UserProfileAccessService

public class UserProfileAccessService
extends java.lang.Object

Author:
Panagiota Koltsida, NKUA

Constructor Summary
UserProfileAccessService()
          The constructor of the class.
 
Method Summary
 VOID deleteElement(java.lang.String elementName)
          This method deletes an element (or a set of elements) of the user's profile
 GetElementResponse getElement(java.lang.String elementName)
          This method retrieves an element of the user's profile.
 java.lang.String getElementValue(java.lang.String elementName)
          This method retrieves the value of a specific element of the user's profile.
 java.lang.String getUserProfile(VOID params)
          This method returns the user profile.
 VOID setElement(SetElement params)
          This method creates a new element in the user's profile.
 VOID setElementValue(SetElementValue params)
          This method sets a new value to an element of the user's profile.
 VOID updateUserProfile(java.lang.String profileContent)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserProfileAccessService

public UserProfileAccessService()
                         throws GCUBEFault
The constructor of the class.

Throws:
GCUBEFault - Failed to contact the IS client
Method Detail

getUserProfile

public java.lang.String getUserProfile(VOID params)
                                throws GCUBEFault
This method returns the user profile.

Parameters:
params - This method has no input parameters
Returns:
A string which contains the user's profile
Throws:
GCUBEFault - an error occurred

getElementValue

public java.lang.String getElementValue(java.lang.String elementName)
                                 throws GCUBEFault
This method retrieves the value of a specific element of the user's profile. If the element does not exist in the profile it returns null.

Parameters:
elementName - It is a XPath expression
Returns:
The value of the element
Throws:
GCUBEFault - an error occurred

setElementValue

public VOID setElementValue(SetElementValue params)
                     throws GCUBEFault
This method sets a new value to an element of the user's profile. If the element has already a value, it replaces it.

Parameters:
params: - elementName,is a XPath expression value, the value to be set
Returns:
no Return type
Throws:
GCUBEFault - an error occurred

getElement

public GetElementResponse getElement(java.lang.String elementName)
                              throws GCUBEFault
This method retrieves an element of the user's profile. If there are many elements with the same name it returns an array which contains all these elements.

Parameters:
elementName - It is a XPath expression
Returns:
the element(s) as an XML node
Throws:
GCUBEFault - an error occurred

setElement

public VOID setElement(SetElement params)
                throws GCUBEFault
This method creates a new element in the user's profile. The elementName and the path are XPath expressions.

Parameters:
params: - elementName, the name of the new element value, the value of the new element path, the path under it the new element will be set.
Returns:
no return type
Throws:
GCUBEFault - an error occurred

deleteElement

public VOID deleteElement(java.lang.String elementName)
                   throws GCUBEFault
This method deletes an element (or a set of elements) of the user's profile

Parameters:
elementName - The element to delete. It is a XPath expression
Returns:
no Return type
Throws:
GCUBEFault - an error occurred

updateUserProfile

public VOID updateUserProfile(java.lang.String profileContent)
                       throws GCUBEFault
Throws:
GCUBEFault