org.hawkular.accounts.api

Interface OrganizationJoinRequestService

All Known Implementing Classes:

OrganizationJoinRequestServiceImpl

public interface OrganizationJoinRequestService

Author:

Juraci Paixão Kröhling

Method Summary

Modifier and Type	Method and Description
OrganizationJoinRequest	accept(OrganizationJoinRequest request, Role role) Accepts a previously created join request
OrganizationJoinRequest	create(Organization organization, Persona persona) Creates a new Join Request on the given Organization by the given Persona
List<OrganizationJoinRequest>	getAllRequestsForOrganization(Organization organization) Lists all join requests for the given organization, no matter the status
List<OrganizationJoinRequest>	getAllRequestsForPersona(Persona persona) Lists all join requests for the given persona, no matter the status
OrganizationJoinRequest	getById(UUID uuid) Retrieve a specific Join Request based on its ID
List<OrganizationJoinRequest>	getPendingRequestsForOrganization(Organization organization) Lists the PENDING join requests for the given organization
OrganizationJoinRequest	reject(OrganizationJoinRequest request) Rejects a previously created join request
void	remove(OrganizationJoinRequest request) Removes a join request from the permanent storage

Method Detail

getById

OrganizationJoinRequest getById(UUID uuid)

Retrieve a specific Join Request based on its ID

Returns:

the OrganizationJoinRequest

create

OrganizationJoinRequest create(Organization organization,
                               Persona persona)

Creates a new Join Request on the given Organization by the given Persona

Parameters:

organization - the organization the persona wants to join

persona - the persona who wants to join the organization

Returns:

a newly created OrganizationJoinRequest

accept

OrganizationJoinRequest accept(OrganizationJoinRequest request,
                               Role role)

Accepts a previously created join request

Parameters:

request - the join request that is being accepted

Returns:

the join request with the new status

reject

OrganizationJoinRequest reject(OrganizationJoinRequest request)

Rejects a previously created join request

Parameters:

request - the join request that is being rejected

Returns:

the join request with the new status

remove

void remove(OrganizationJoinRequest request)

Removes a join request from the permanent storage

Parameters:

request - the join request to remove

getPendingRequestsForOrganization

List<OrganizationJoinRequest> getPendingRequestsForOrganization(Organization organization)

Lists the PENDING join requests for the given organization

Parameters:

organization - the organization to list the pending requests

Returns:

a List of OrganizationJoinRequest with PENDING as status

getAllRequestsForOrganization

List<OrganizationJoinRequest> getAllRequestsForOrganization(Organization organization)

Lists all join requests for the given organization, no matter the status

Parameters:

organization - the organization to list the requests

Returns:

a List of OrganizationJoinRequest

getAllRequestsForPersona

List<OrganizationJoinRequest> getAllRequestsForPersona(Persona persona)

Lists all join requests for the given persona, no matter the status

Parameters:

persona - the persona

Returns:

a List of OrganizationJoinRequest