Package com.softlayer.api.service.account.regional.registry

Interface Detail.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Detail

@ApiService("SoftLayer_Account_Regional_Registry_Detail")
public static interface Detail.Service
extends Service

Regional Registry Detail objects are used to specify the information you wish to use when registering subnets with the appropriate Regional Internet Registries.

See Also:

SoftLayer_Account_Regional_Registry_Detail

Method Summary

Modifier and Type	Method	Description
Detail.ServiceAsync	asAsync()	Get an async version of this service
Detail	createObject(Detail templateObject)	.create_object > li > div { padding-top: .5em; padding-bottom: .5em} This method will create a new SoftLayer_Account_Regional_Registry_Detail object.
Boolean	deleteObject()	This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object.
Boolean	editObject(Detail templateObject)	This method will edit an existing SoftLayer_Account_Regional_Registry_Detail object.
Account	getAccount()	The account that this detail object belongs to.
List<Details>	getDetails()	References to the [[SoftLayer_Network_Subnet_Registration|registration objects]] that consume this detail object.
Type	getDetailType()	The associated type of this detail object.
Detail	getObject()
List<Property>	getProperties()	The individual properties that define this detail object's values.
Handle	getRegionalInternetRegistryHandle()	The associated RWhois handle of this detail object.
void	setMask(Detail.Mask mask)
TransactionDetails	updateReferencedRegistrations()	This method will create a bulk transaction to update any registrations that reference this detail object.
List<Message>	validatePersonForAllRegistrars()	Validates this person detail against all supported external registrars (APNIC/ARIN/RIPE).
Detail.Mask	withMask()	Use the existing mask on this service or create it if not present
Detail.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

Detail.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Detail.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

Detail.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(Detail.Mask mask)

createObject

@ApiMethod
Detail createObject(Detail templateObject)

This method will create a new SoftLayer_Account_Regional_Registry_Detail object.

Input - [[SoftLayer_Account_Regional_Registry_Detail (type)|SoftLayer_Account_Regional_Registry_Detail]]

• detailTypeId
  The [[SoftLayer_Account_Regional_Registry_Detail_Type|type id]] of this detail object
  • Required
  • Type - integer
• regionalInternetRegistryHandleId
  The id of the [[SoftLayer_Account_Rwhois_Handle|RWhois handle]] object. This is only to be used for detailed registrations, where a subnet is registered to an organization. The associated handle will be required to be a valid organization object id at the relevant registry. In this case, the detail object will only be valid for the registry the organization belongs to.
  • Optional
  • Type - integer

See Also:

SoftLayer_Account_Regional_Registry_Detail::createObject

deleteObject

@ApiMethod(instanceRequired=true)
Boolean deleteObject()

This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object.

See Also:

SoftLayer_Account_Regional_Registry_Detail::deleteObject

editObject

@ApiMethod(instanceRequired=true)
Boolean editObject(Detail templateObject)

This method will edit an existing SoftLayer_Account_Regional_Registry_Detail object. For more detail, see [[SoftLayer_Account_Regional_Registry_Detail::createObject|createObject]].

See Also:

SoftLayer_Account_Regional_Registry_Detail::editObject

getObject

@ApiMethod(instanceRequired=true)
Detail getObject()

See Also:

SoftLayer_Account_Regional_Registry_Detail::getObject

updateReferencedRegistrations

@ApiMethod(instanceRequired=true)
TransactionDetails updateReferencedRegistrations()

This method will create a bulk transaction to update any registrations that reference this detail object. It should only be called from a child class such as [[SoftLayer_Account_Regional_Registry_Detail_Person]] or [[SoftLayer_Account_Regional_Registry_Detail_Network]]. The registrations should be in the Open or Registration_Complete status.

See Also:

SoftLayer_Account_Regional_Registry_Detail::updateReferencedRegistrations

validatePersonForAllRegistrars

@ApiMethod(instanceRequired=true)
List<Message> validatePersonForAllRegistrars()

Validates this person detail against all supported external registrars (APNIC/ARIN/RIPE). The validation uses the most restrictive rules ensuring that any person detail passing this validation would be acceptable to any supported registrar.

The person detail properties are validated against - Non-emptiness - Minimum length - Maximum length - Maximum words - Supported characters - Format of data

If the person detail validation succeeds, then an empty list is returned indicating no errors were found and that this person detail would work against all three registrars during a subnet registration.

If the person detail validation fails, then an array of validation errors (SoftLayer_Container_Message[]) is returned. Each message container contains error messages grouped by property type and a message type indicating the person detail property type object which failed validation. It is possible to create a subnet registration using a person detail which does not pass this validation, but at least one registrar would reject it for being invalid.

See Also:

SoftLayer_Account_Regional_Registry_Detail::validatePersonForAllRegistrars

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

The account that this detail object belongs to.

See Also:

SoftLayer_Account_Regional_Registry_Detail::getAccount

getDetailType

@ApiMethod(instanceRequired=true)
Type getDetailType()

The associated type of this detail object.

See Also:

SoftLayer_Account_Regional_Registry_Detail::getDetailType

getDetails

@ApiMethod(instanceRequired=true)
List<Details> getDetails()

References to the [[SoftLayer_Network_Subnet_Registration|registration objects]] that consume this detail object.

See Also:

SoftLayer_Account_Regional_Registry_Detail::getDetails

getProperties

@ApiMethod(instanceRequired=true)
List<Property> getProperties()

The individual properties that define this detail object's values.

See Also:

SoftLayer_Account_Regional_Registry_Detail::getProperties

getRegionalInternetRegistryHandle

@ApiMethod(instanceRequired=true)
Handle getRegionalInternetRegistryHandle()

The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary.

See Also:

SoftLayer_Account_Regional_Registry_Detail::getRegionalInternetRegistryHandle