Skip navigation links

oracle.wcps.people
Class PeopleExecutableResource

java.lang.Object
WebCenterRestExecutableResource
oracle.wcps.people.PeopleExecutableResource

public class PeopleExecutableResource

extends WebCenterRestExecutableResource

The name of this executable resource is based on the fact that the resourceType of the link in the resourceIndex, that is used to find the starting point for this resource is, "urn:oracle:webcenter:people".

Constructor Summary

PeopleExecutableResource(WebCenterRestConnectionConfig restConfig)

Method Summary

void	deleteConnection(java.lang.String loginId) Remove the specified user from the authenticated user's connections.
Person	getMe() Returns the current user profile.
java.util.List<Person>	getMyConnections() Returns the people that the current user is connected to.
protected void	setResourceType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeopleExecutableResource

public PeopleExecutableResource(WebCenterRestConnectionConfig restConfig)

Method Detail

setResourceType

protected void setResourceType()

getMe

@PublicFunction(functionName="getMe",
                descriptionBundleKey="provider.method.getMe.description")
public Person getMe()

Returns the current user profile.

Returns:

return a Person representing the authenticated user.

getMyConnections

@PublicFunction(functionName="getMyConnections",
                descriptionBundleKey="provider.method.getMyConnections.description")
public java.util.List<Person> getMyConnections()

Returns the people that the current user is connected to.

Returns:

return List or Person objects that are connected to the currently authenticated user.

deleteConnection

@PublicFunction(functionName="deleteConnection",
                descriptionBundleKey="provider.method.deleteConnection.description")
public void deleteConnection(@PublicParameter(parameterName="loginId",descriptionBundleKey="provider.parameter.deleteConnection.loginId.description")
                                                                            java.lang.String loginId)

Remove the specified user from the authenticated user's connections.

Parameters:

loginId - The loginId of the user to remove from the connections list.

Skip navigation links