All Superinterfaces:: Maskable, ResultLimitable, Service

Enclosing class:: Registration

@ApiService("SoftLayer_Dns_Domain_Registration")
public static interface Registration.Service
extends Service

Registration and management of domain names and domain related services.

See Also:: SoftLayer_Dns_Domain_Registration

Method Summary

Modifier and Type	Method	Description
`Boolean`	`addNameserversToDomain(List<String> nameservers)`	The addNameserversToDomain method adds nameservers to a domain for a domain that already has nameservers assigned to it.
`Registration.ServiceAsync`	`asAsync()`	Get an async version of this service
`Boolean`	`deleteRegisteredNameserver(String nameserver)`	The deleteRegisteredNameserver method deletes a nameserver that was registered, provided it is not currently serving a domain
`Account`	`getAccount()`	The SoftLayer customer account that the domain is registered to.
`String`	`getAuthenticationCode()`	The getAuthenticationCode method retrieves the authentication code for the domain.
`Information`	`getDomainInformation()`	The getDomainInformation method retrieves all the information for a domain.
`List<Nameserver>`	`getDomainNameservers()`	The getDomainNameservers method retrieve nameservers information for domain.
`Status`	`getDomainRegistrationStatus()`	The domain registration status.
`List<ExtendedAttribute>`	`getExtendedAttributes(String domainName)`	The getExtendedAttributes method determines if a country code top level domain requires extended attributes.
`Registration`	`getObject()`	getObject retrieves the SoftLayer_Dns_Domain_Registration object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_Registration service.
`Nameserver`	`getRegisteredNameserver()`	The getRegisteredNameserver method retrieves registered nameservers.
`Status`	`getRegistrantVerificationStatus()`	The registrant verification status.
`StatusDetail`	`getRegistrantVerificationStatusDetail()`	When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct.
`Provider`	`getServiceProvider()`
`Information`	`getTransferInformation(String domainName)`	The getTransferInformation method checks to see if the domain can be transferred and also can be used to check the status of the last transfer request.
`Boolean`	`lockDomain()`	The lockDomain method locks a domain to prevent unauthorized, unwanted or accidental changes to the domain name.
`List<Lookup>`	`lookupDomain(String domainName)`	The lookupDomain method checks whether a specified domain name is available for registration in TLD's, and suggests other similar domain names, and checks whether they are available as well.
`Boolean`	`modifyContact(Contact contact)`	The modifyContact method modifies contact information (admin, billing, owner, technical) for a domain.
`Boolean`	`modifyRegisteredNameserver(String oldNameserver, String newNameserver, String ipAddress)`	The modifyRegisteredNameserver method modifies a nameserver that was registered.
`Boolean`	`registerNameserver(String nameserver, String ipAddress)`	The registerNameserver method creates a nameserver for the domain.
`Boolean`	`removeNameserversFromDomain(List<String> nameservers)`	The removeNameserversFromDomain method removes nameservers from a domain for a domain that already has nameservers assigned to it.
`Boolean`	`sendAuthenticationCode()`	The sendAuthenticationCode method sends the authentication code to the administrative contact for the domain.
`Boolean`	`sendRegistrantVerificationEmail()`	When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct.
`Boolean`	`sendTransferApprovalEmail()`	The sendTransferApprovalEmail method resends a transfer approval email message for a transfer that is in 'pending owner approval' state, to the admin contact listed for the domain at the time that the transfer request was submitted
`Boolean`	`setAuthenticationCode(String authenticationCode)`	The setAuthenticationCode method sets the authentication code for the domain.
`void`	`setMask(Registration.Mask mask)`
`Boolean`	`unlockDomain()`	The unlockDomain method unlocks a domain
`Registration.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Registration.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details
- asAsync
  
  Registration.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Registration.Mask withNewMask()
  
  Description copied from interface: Maskable
  
  Overwrite the existing mask on this service with a new one and return it
  
  Specified by:
  
  withNewMask in interface Maskable
- withMask
  
  Registration.Mask withMask()
  
  Description copied from interface: Maskable
  
  Use the existing mask on this service or create it if not present
  
  Specified by:
  
  withMask in interface Maskable
- setMask
  
  void setMask(Registration.Mask mask)
- addNameserversToDomain
  
  @ApiMethod(instanceRequired=true) Boolean addNameserversToDomain(List<String> nameservers)
  
  The addNameserversToDomain method adds nameservers to a domain for a domain that already has nameservers assigned to it. This method does not create a nameserver; the nameserver must already exist.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::addNameserversToDomain
- deleteRegisteredNameserver
  
  @ApiMethod(instanceRequired=true) Boolean deleteRegisteredNameserver(String nameserver)
  
  The deleteRegisteredNameserver method deletes a nameserver that was registered, provided it is not currently serving a domain
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::deleteRegisteredNameserver
- getAuthenticationCode
  
  @ApiMethod(instanceRequired=true) String getAuthenticationCode()
  
  The getAuthenticationCode method retrieves the authentication code for the domain.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::getAuthenticationCode
- getDomainInformation
  
  @ApiMethod(instanceRequired=true) Information getDomainInformation()
  
  The getDomainInformation method retrieves all the information for a domain.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::getDomainInformation
- getDomainNameservers
  
  @ApiMethod(instanceRequired=true) List<Nameserver> getDomainNameservers()
  
  The getDomainNameservers method retrieve nameservers information for domain.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::getDomainNameservers
- getExtendedAttributes
  
  @ApiMethod List<ExtendedAttribute> getExtendedAttributes(String domainName)
  
  The getExtendedAttributes method determines if a country code top level domain requires extended attributes.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::getExtendedAttributes
- getObject
  
  @ApiMethod(instanceRequired=true) Registration getObject()
  
  getObject retrieves the SoftLayer_Dns_Domain_Registration object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_Registration service.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::getObject
- getRegisteredNameserver
  
  @ApiMethod(instanceRequired=true) Nameserver getRegisteredNameserver()
  
  The getRegisteredNameserver method retrieves registered nameservers.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::getRegisteredNameserver
- getRegistrantVerificationStatusDetail
  
  @ApiMethod(instanceRequired=true) StatusDetail getRegistrantVerificationStatusDetail()
  
  When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct. This method returns the current state of the verification request.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::getRegistrantVerificationStatusDetail
- getTransferInformation
  
  @ApiMethod Information getTransferInformation(String domainName)
  
  The getTransferInformation method checks to see if the domain can be transferred and also can be used to check the status of the last transfer request.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::getTransferInformation
- lockDomain
  
  @ApiMethod(instanceRequired=true) Boolean lockDomain()
  
  The lockDomain method locks a domain to prevent unauthorized, unwanted or accidental changes to the domain name. When set, the following actions are prohibited:
  * Transferring of the domain name
  * Deletion of the domain name
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::lockDomain
- lookupDomain
  
  @ApiMethod List<Lookup> lookupDomain(String domainName)
  
  The lookupDomain method checks whether a specified domain name is available for registration in TLD's, and suggests other similar domain names, and checks whether they are available as well.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::lookupDomain
- modifyContact
  
  @ApiMethod(instanceRequired=true) Boolean modifyContact(Contact contact)
  
  The modifyContact method modifies contact information (admin, billing, owner, technical) for a domain.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::modifyContact
- modifyRegisteredNameserver
  
  @ApiMethod(instanceRequired=true) Boolean modifyRegisteredNameserver(String oldNameserver, String newNameserver, String ipAddress)
  
  The modifyRegisteredNameserver method modifies a nameserver that was registered.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::modifyRegisteredNameserver
- registerNameserver
  
  @ApiMethod(instanceRequired=true) Boolean registerNameserver(String nameserver, String ipAddress)
  
  The registerNameserver method creates a nameserver for the domain.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::registerNameserver
- removeNameserversFromDomain
  
  @ApiMethod(instanceRequired=true) Boolean removeNameserversFromDomain(List<String> nameservers)
  
  The removeNameserversFromDomain method removes nameservers from a domain for a domain that already has nameservers assigned to it.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::removeNameserversFromDomain
- sendAuthenticationCode
  
  @ApiMethod(instanceRequired=true) Boolean sendAuthenticationCode()
  
  The sendAuthenticationCode method sends the authentication code to the administrative contact for the domain.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::sendAuthenticationCode
- sendRegistrantVerificationEmail
  
  @ApiMethod(instanceRequired=true) Boolean sendRegistrantVerificationEmail()
  
  When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct. This method sends the verification email to the registrant.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::sendRegistrantVerificationEmail
- sendTransferApprovalEmail
  
  @ApiMethod(instanceRequired=true) Boolean sendTransferApprovalEmail()
  
  The sendTransferApprovalEmail method resends a transfer approval email message for a transfer that is in 'pending owner approval' state, to the admin contact listed for the domain at the time that the transfer request was submitted
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::sendTransferApprovalEmail
- setAuthenticationCode
  
  @ApiMethod(instanceRequired=true) Boolean setAuthenticationCode(String authenticationCode)
  
  The setAuthenticationCode method sets the authentication code for the domain. The authentication code is a transfer key and provides an extra level of security, safeguarding domain names from unauthorized transfers.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::setAuthenticationCode
- unlockDomain
  
  @ApiMethod(instanceRequired=true) Boolean unlockDomain()
  
  The unlockDomain method unlocks a domain
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::unlockDomain
- getAccount
  
  @ApiMethod(instanceRequired=true) Account getAccount()
  
  The SoftLayer customer account that the domain is registered to.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::getAccount
- getDomainRegistrationStatus
  
  @ApiMethod(instanceRequired=true) Status getDomainRegistrationStatus()
  
  The domain registration status.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::getDomainRegistrationStatus
- getRegistrantVerificationStatus
  
  @ApiMethod(instanceRequired=true) Status getRegistrantVerificationStatus()
  
  The registrant verification status.
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::getRegistrantVerificationStatus
- getServiceProvider
  
  @ApiMethod(instanceRequired=true) Provider getServiceProvider()
  
  See Also:
  
  SoftLayer_Dns_Domain_Registration::getServiceProvider

Interface Registration.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details