com.covisint.platform.user.client.sdk

Interface PersonInvitationSDK.PersonInvitationClient

Enclosing class:

PersonInvitationSDK

public static interface PersonInvitationSDK.PersonInvitationClient

Client interface for the PersonInvitation resource APIs.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	accept(String inviteId, String createdPersonId) Accept a person invitation with invite id.
com.google.common.util.concurrent.CheckedFuture<PersonInvitation,com.covisint.core.http.service.core.ServiceException>	add(PersonInvitation invite) Add a new person invitation.
com.google.common.util.concurrent.CheckedFuture<PersonInvitation,com.covisint.core.http.service.core.ServiceException>	delete(String inviteId) Delete a person invitation.
com.google.common.util.concurrent.CheckedFuture<PersonInvitation,com.covisint.core.http.service.core.ServiceException>	get(String inviteId) Get a person invitation by id.
com.google.common.util.concurrent.CheckedFuture<List<PersonInvitation>,com.covisint.core.http.service.core.ServiceException>	search(List<String> inviteeIds, List<String> invitorIds, com.covisint.core.http.service.core.Page page) Search for person invitations based on the given criteria.

Method Detail

get

@Nonnull
com.google.common.util.concurrent.CheckedFuture<PersonInvitation,com.covisint.core.http.service.core.ServiceException> get(@Nonnull@NotEmpty
                                                                                                                                 String inviteId)

Get a person invitation by id.

Parameters:

inviteId - The id of the person invitation to be returned.

Returns:

Returns a future producing the person invitation resource, if it exists, otherwise produces null.

add

@Nonnull
com.google.common.util.concurrent.CheckedFuture<PersonInvitation,com.covisint.core.http.service.core.ServiceException> add(@Nonnull
                                                                                                                                 PersonInvitation invite)

Add a new person invitation.

Parameters:

invite - The person invitation to be added.

Returns:

Returns a future that will produce the newly created person invitation resource. This resource will contain the server-issued id and version.

delete

@Nonnull
com.google.common.util.concurrent.CheckedFuture<PersonInvitation,com.covisint.core.http.service.core.ServiceException> delete(@Nonnull@NotEmpty
                                                                                                                                    String inviteId)

Delete a person invitation.

Parameters:

inviteId - The id of the person invitation to delete.

Returns:

Returns a future that will produce the deleted person invitation.

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<PersonInvitation>,com.covisint.core.http.service.core.ServiceException> search(List<String> inviteeIds,
                                                                                                                                          List<String> invitorIds,
                                                                                                                                          @Nonnull
                                                                                                                                          com.covisint.core.http.service.core.Page page)

Search for person invitations based on the given criteria.

Parameters:

inviteeIds - The invitee ids to search. Returns all invitations sent to one of the specified invitees. Pass null to skip filtering on invitee.

invitorIds - The invitor ids to search. Returns all invitations sent by one of the specified invitors. Pass null to skip filtering on invitor.

page - The pagination criteria. Use Page.DEFAULT if no specific page criteria is needed.

Returns:

Returns a future producing a list of all matching person invitations.

accept

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> accept(@Nonnull@NotEmpty
                                                                                                                        String inviteId,
                                                                                                                        @Nonnull@NotEmpty
                                                                                                                        String createdPersonId)

Accept a person invitation with invite id.

Parameters:

inviteId - The unique identifier of the invitation being accepted.

createdPersonId - The unique identifier of the person created during the registration process that was initiated by the accepted invitation. This is specified solely for tracking purposes.

Returns:

Returns a future which can be used to check for successful completion.