Skip navigation links

oracle.wcps.people
Class PersonExecutableResource

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

public class PersonExecutableResource

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:person".

Constructor Summary

PersonExecutableResource(WebCenterRestConnectionConfig restConfig)

Method Summary

Person	getPerson(java.lang.String loginId) Get a user based on its login id.
Person	getPersonByQuery(java.lang.String query) Get a person based on a query.
protected void	setResourceType()

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonExecutableResource

public PersonExecutableResource(WebCenterRestConnectionConfig restConfig)

Method Detail

setResourceType

protected void setResourceType()

getPerson

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

Get a user based on its login id.

Parameters:

loginId - The login id of the person to retrieve

Returns:

a Person

getPersonByQuery

@PublicFunction(functionName="getPersonByQuery",
                descriptionBundleKey="provider.method.getPersonByQuery.description")
public Person getPersonByQuery(@PublicParameter(parameterName="query",descriptionBundleKey="provider.parameter.getPersonByQuery.query.description")
                                                                              java.lang.String query)

Get a person based on a query.

Parameters:

query - The query used to find a person in format: loginid:equals:username or guid:equals:guid or email:equals:email)

Returns:

a Person

Skip navigation links