Add javadoc to contact/host flows and mark them final

Also make minor javadoc tweaks to domain transfer flows
to match what we are changing in contact/host flows.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=133955677
This commit is contained in:
cgoldfeder 2016-09-22 08:21:09 -07:00 committed by Ben McIlwain
parent a69fc769af
commit 0564bcdbc9
20 changed files with 120 additions and 44 deletions

View file

@ -32,14 +32,21 @@ import google.registry.model.eppoutput.EppOutput;
import javax.inject.Inject;
/**
* An EPP flow that queries a pending transfer on a {@link ContactResource}.
* An EPP flow that queries a pending transfer on a contact.
*
* <p>The "gaining" registrar requests a transfer from the "losing" (aka current) registrar. The
* losing registrar has a "transfer" time period to respond (by default five days) after which the
* transfer is automatically approved. This flow can be used by the gaining or losing registrars
* (or anyone with the correct authId) to see the status of a transfer, which may still be pending
* or may have been approved, rejected, cancelled or implicitly approved by virtue of the transfer
* period expiring.
*
* @error {@link google.registry.flows.ResourceFlowUtils.BadAuthInfoForResourceException}
* @error {@link google.registry.flows.exceptions.NoTransferHistoryToQueryException}
* @error {@link google.registry.flows.exceptions.NotAuthorizedToViewTransferException}
* @error {@link google.registry.flows.exceptions.ResourceToQueryDoesNotExistException}
*/
public class ContactTransferQueryFlow extends LoggedInFlow {
public final class ContactTransferQueryFlow extends LoggedInFlow {
@Inject Optional<AuthInfo> authInfo;
@Inject @ClientId String clientId;