com.softlayer.api.service.Brand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
package com.softlayer.api.service;
import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.Hardware;
import com.softlayer.api.service.Ticket;
import com.softlayer.api.service.brand.Contact;
import com.softlayer.api.service.brand.restriction.location.CustomerCountry;
import com.softlayer.api.service.product.Catalog;
import com.softlayer.api.service.ticket.Group;
import com.softlayer.api.service.ticket.Subject;
import com.softlayer.api.service.user.Customer;
import com.softlayer.api.service.virtual.Guest;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Future;
/**
* The SoftLayer_Brand data type contains brand information relating to the single SoftLayer customer account.
*
* SoftLayer customers are unable to change their brand information in the portal or the API.
*
* @see SoftLayer_Brand
*/
@ApiType("SoftLayer_Brand")
public class Brand extends Entity {
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
/**
* All accounts owned by the brand.
*/
@ApiProperty
protected List allOwnedAccounts;
public List getAllOwnedAccounts() {
if (allOwnedAccounts == null) {
allOwnedAccounts = new ArrayList();
}
return allOwnedAccounts;
}
/**
* This flag indicates if creation of accounts is allowed.
*/
@ApiProperty
protected Boolean allowAccountCreationFlag;
public Boolean getAllowAccountCreationFlag() {
return allowAccountCreationFlag;
}
public void setAllowAccountCreationFlag(Boolean allowAccountCreationFlag) {
this.allowAccountCreationFlag = allowAccountCreationFlag;
}
/**
* The Product Catalog for the Brand
*/
@ApiProperty
protected Catalog catalog;
public Catalog getCatalog() {
return catalog;
}
public void setCatalog(Catalog catalog) {
this.catalog = catalog;
}
/**
* The contacts for the brand.
*/
@ApiProperty
protected List contacts;
public List getContacts() {
if (contacts == null) {
contacts = new ArrayList();
}
return contacts;
}
/**
* This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain.
*/
@ApiProperty
protected List customerCountryLocationRestrictions;
public List getCustomerCountryLocationRestrictions() {
if (customerCountryLocationRestrictions == null) {
customerCountryLocationRestrictions = new ArrayList();
}
return customerCountryLocationRestrictions;
}
@ApiProperty
protected Brand distributor;
public Brand getDistributor() {
return distributor;
}
public void setDistributor(Brand distributor) {
this.distributor = distributor;
}
@ApiProperty
protected Boolean distributorChildFlag;
public Boolean getDistributorChildFlag() {
return distributorChildFlag;
}
public void setDistributorChildFlag(Boolean distributorChildFlag) {
this.distributorChildFlag = distributorChildFlag;
}
@ApiProperty
protected String distributorFlag;
public String getDistributorFlag() {
return distributorFlag;
}
public void setDistributorFlag(String distributorFlag) {
this.distributorFlag = distributorFlag;
}
/**
* An account's associated hardware objects.
*/
@ApiProperty
protected List hardware;
public List getHardware() {
if (hardware == null) {
hardware = new ArrayList();
}
return hardware;
}
@ApiProperty
protected Boolean hasAgentSupportFlag;
public Boolean getHasAgentSupportFlag() {
return hasAgentSupportFlag;
}
public void setHasAgentSupportFlag(Boolean hasAgentSupportFlag) {
this.hasAgentSupportFlag = hasAgentSupportFlag;
}
@ApiProperty
protected List openTickets;
public List getOpenTickets() {
if (openTickets == null) {
openTickets = new ArrayList();
}
return openTickets;
}
/**
* Active accounts owned by the brand.
*/
@ApiProperty
protected List ownedAccounts;
public List getOwnedAccounts() {
if (ownedAccounts == null) {
ownedAccounts = new ArrayList();
}
return ownedAccounts;
}
@ApiProperty
protected List ticketGroups;
public List getTicketGroups() {
if (ticketGroups == null) {
ticketGroups = new ArrayList();
}
return ticketGroups;
}
@ApiProperty
protected List tickets;
public List getTickets() {
if (tickets == null) {
tickets = new ArrayList();
}
return tickets;
}
@ApiProperty
protected List users;
public List getUsers() {
if (users == null) {
users = new ArrayList();
}
return users;
}
/**
* An account's associated virtual guest objects.
*/
@ApiProperty
protected List virtualGuests;
public List getVirtualGuests() {
if (virtualGuests == null) {
virtualGuests = new ArrayList();
}
return virtualGuests;
}
/**
* ID of the Catalog used by this Brand
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long catalogId;
public Long getCatalogId() {
return catalogId;
}
public void setCatalogId(Long catalogId) {
catalogIdSpecified = true;
this.catalogId = catalogId;
}
protected boolean catalogIdSpecified;
public boolean isCatalogIdSpecified() {
return catalogIdSpecified;
}
public void unsetCatalogId() {
catalogId = null;
catalogIdSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected Long id;
public Long getId() {
return id;
}
public void setId(Long id) {
idSpecified = true;
this.id = id;
}
protected boolean idSpecified;
public boolean isIdSpecified() {
return idSpecified;
}
public void unsetId() {
id = null;
idSpecified = false;
}
/**
* The brand key name.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String keyName;
public String getKeyName() {
return keyName;
}
public void setKeyName(String keyName) {
keyNameSpecified = true;
this.keyName = keyName;
}
protected boolean keyNameSpecified;
public boolean isKeyNameSpecified() {
return keyNameSpecified;
}
public void unsetKeyName() {
keyName = null;
keyNameSpecified = false;
}
/**
* The brand long name.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String longName;
public String getLongName() {
return longName;
}
public void setLongName(String longName) {
longNameSpecified = true;
this.longName = longName;
}
protected boolean longNameSpecified;
public boolean isLongNameSpecified() {
return longNameSpecified;
}
public void unsetLongName() {
longName = null;
longNameSpecified = false;
}
/**
* The brand name.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String name;
public String getName() {
return name;
}
public void setName(String name) {
nameSpecified = true;
this.name = name;
}
protected boolean nameSpecified;
public boolean isNameSpecified() {
return nameSpecified;
}
public void unsetName() {
name = null;
nameSpecified = false;
}
/**
* A count of all accounts owned by the brand.
*/
@ApiProperty
protected Long allOwnedAccountCount;
public Long getAllOwnedAccountCount() {
return allOwnedAccountCount;
}
public void setAllOwnedAccountCount(Long allOwnedAccountCount) {
this.allOwnedAccountCount = allOwnedAccountCount;
}
/**
* A count of the contacts for the brand.
*/
@ApiProperty
protected Long contactCount;
public Long getContactCount() {
return contactCount;
}
public void setContactCount(Long contactCount) {
this.contactCount = contactCount;
}
/**
* A count of this references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain.
*/
@ApiProperty
protected Long customerCountryLocationRestrictionCount;
public Long getCustomerCountryLocationRestrictionCount() {
return customerCountryLocationRestrictionCount;
}
public void setCustomerCountryLocationRestrictionCount(Long customerCountryLocationRestrictionCount) {
this.customerCountryLocationRestrictionCount = customerCountryLocationRestrictionCount;
}
/**
* A count of an account's associated hardware objects.
*/
@ApiProperty
protected Long hardwareCount;
public Long getHardwareCount() {
return hardwareCount;
}
public void setHardwareCount(Long hardwareCount) {
this.hardwareCount = hardwareCount;
}
/**
* A count of
*/
@ApiProperty
protected Long openTicketCount;
public Long getOpenTicketCount() {
return openTicketCount;
}
public void setOpenTicketCount(Long openTicketCount) {
this.openTicketCount = openTicketCount;
}
/**
* A count of active accounts owned by the brand.
*/
@ApiProperty
protected Long ownedAccountCount;
public Long getOwnedAccountCount() {
return ownedAccountCount;
}
public void setOwnedAccountCount(Long ownedAccountCount) {
this.ownedAccountCount = ownedAccountCount;
}
/**
* A count of
*/
@ApiProperty
protected Long ticketCount;
public Long getTicketCount() {
return ticketCount;
}
public void setTicketCount(Long ticketCount) {
this.ticketCount = ticketCount;
}
/**
* A count of
*/
@ApiProperty
protected Long ticketGroupCount;
public Long getTicketGroupCount() {
return ticketGroupCount;
}
public void setTicketGroupCount(Long ticketGroupCount) {
this.ticketGroupCount = ticketGroupCount;
}
/**
* A count of
*/
@ApiProperty
protected Long userCount;
public Long getUserCount() {
return userCount;
}
public void setUserCount(Long userCount) {
this.userCount = userCount;
}
/**
* A count of an account's associated virtual guest objects.
*/
@ApiProperty
protected Long virtualGuestCount;
public Long getVirtualGuestCount() {
return virtualGuestCount;
}
public void setVirtualGuestCount(Long virtualGuestCount) {
this.virtualGuestCount = virtualGuestCount;
}
public Service asService(ApiClient client) {
return service(client, id);
}
public static Service service(ApiClient client) {
return client.createService(Service.class, null);
}
public static Service service(ApiClient client, Long id) {
return client.createService(Service.class, id == null ? null : id.toString());
}
/**
* Every SoftLayer customer account is associated to a brand
*
* SoftLayer customers are unable to change their brand information in the portal or the API.
*
* @see SoftLayer_Brand
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Brand")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Create a new customer account record.
*
* @see SoftLayer_Brand::createCustomerAccount
*/
@ApiMethod
public Account createCustomerAccount(Account account, Boolean bypassDuplicateAccountCheck);
/**
* Create a new brand record.
*
* @see SoftLayer_Brand::createObject
*/
@ApiMethod
public Brand createObject(Brand templateObject);
/**
* (DEPRECATED) Use [[SoftLayer_Ticket_Subject::getAllObjects]] method.
*
* @see SoftLayer_Brand::getAllTicketSubjects
*/
@ApiMethod(instanceRequired = true)
public List getAllTicketSubjects(Account account);
/**
* Retrieve the contact information for the brand such as the corporate or support contact. This will include the contact name, telephone number, fax number, email address, and mailing address of the contact.
*
* @see SoftLayer_Brand::getContactInformation
*/
@ApiMethod(instanceRequired = true)
public List getContactInformation();
/**
* Get the payment processor merchant name.
*
* @see SoftLayer_Brand::getMerchantName
*/
@ApiMethod(instanceRequired = true)
public String getMerchantName();
/**
* @see SoftLayer_Brand::getObject
*/
@ApiMethod(instanceRequired = true)
public Brand getObject();
/**
* @see SoftLayer_Brand::getToken
*/
@ApiMethod(instanceRequired = true)
public String getToken(Long userId);
/**
* @see SoftLayer_Brand::getAccount
*/
@ApiMethod(instanceRequired = true)
public Account getAccount();
/**
* All accounts owned by the brand.
*
* @see SoftLayer_Brand::getAllOwnedAccounts
*/
@ApiMethod(instanceRequired = true)
public List getAllOwnedAccounts();
/**
* This flag indicates if creation of accounts is allowed.
*
* @see SoftLayer_Brand::getAllowAccountCreationFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getAllowAccountCreationFlag();
/**
* The Product Catalog for the Brand
*
* @see SoftLayer_Brand::getCatalog
*/
@ApiMethod(instanceRequired = true)
public Catalog getCatalog();
/**
* The contacts for the brand.
*
* @see SoftLayer_Brand::getContacts
*/
@ApiMethod(instanceRequired = true)
public List getContacts();
/**
* This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain.
*
* @see SoftLayer_Brand::getCustomerCountryLocationRestrictions
*/
@ApiMethod(instanceRequired = true)
public List getCustomerCountryLocationRestrictions();
/**
* @see SoftLayer_Brand::getDistributor
*/
@ApiMethod(instanceRequired = true)
public Brand getDistributor();
/**
* @see SoftLayer_Brand::getDistributorChildFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getDistributorChildFlag();
/**
* @see SoftLayer_Brand::getDistributorFlag
*/
@ApiMethod(instanceRequired = true)
public String getDistributorFlag();
/**
* An account's associated hardware objects.
*
* @see SoftLayer_Brand::getHardware
*/
@ApiMethod(instanceRequired = true)
public List getHardware();
/**
* @see SoftLayer_Brand::getHasAgentSupportFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getHasAgentSupportFlag();
/**
* @see SoftLayer_Brand::getOpenTickets
*/
@ApiMethod(instanceRequired = true)
public List getOpenTickets();
/**
* Active accounts owned by the brand.
*
* @see SoftLayer_Brand::getOwnedAccounts
*/
@ApiMethod(instanceRequired = true)
public List getOwnedAccounts();
/**
* @see SoftLayer_Brand::getTicketGroups
*/
@ApiMethod(instanceRequired = true)
public List getTicketGroups();
/**
* @see SoftLayer_Brand::getTickets
*/
@ApiMethod(instanceRequired = true)
public List getTickets();
/**
* @see SoftLayer_Brand::getUsers
*/
@ApiMethod(instanceRequired = true)
public List getUsers();
/**
* An account's associated virtual guest objects.
*
* @see SoftLayer_Brand::getVirtualGuests
*/
@ApiMethod(instanceRequired = true)
public List getVirtualGuests();
}
public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Async version of {@link Service#createCustomerAccount}
*/
public Future createCustomerAccount(Account account, Boolean bypassDuplicateAccountCheck);
public Future createCustomerAccount(Account account, Boolean bypassDuplicateAccountCheck, ResponseHandler callback);
/**
* Async version of {@link Service#createObject}
*/
public Future createObject(Brand templateObject);
public Future createObject(Brand templateObject, ResponseHandler callback);
/**
* Async version of {@link Service#getAllTicketSubjects}
*/
public Future> getAllTicketSubjects(Account account);
public Future getAllTicketSubjects(Account account, ResponseHandler> callback);
/**
* Async version of {@link Service#getContactInformation}
*/
public Future> getContactInformation();
public Future getContactInformation(ResponseHandler> callback);
/**
* Async version of {@link Service#getMerchantName}
*/
public Future getMerchantName();
public Future getMerchantName(ResponseHandler callback);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future getObject(ResponseHandler callback);
/**
* Async version of {@link Service#getToken}
*/
public Future getToken(Long userId);
public Future getToken(Long userId, ResponseHandler callback);
/**
* Async version of {@link Service#getAccount}
*/
public Future getAccount();
/**
* Async callback version of {@link Service#getAccount}
*/
public Future getAccount(ResponseHandler callback);
/**
* Async version of {@link Service#getAllOwnedAccounts}
*/
public Future> getAllOwnedAccounts();
/**
* Async callback version of {@link Service#getAllOwnedAccounts}
*/
public Future getAllOwnedAccounts(ResponseHandler> callback);
/**
* Async version of {@link Service#getAllowAccountCreationFlag}
*/
public Future getAllowAccountCreationFlag();
/**
* Async callback version of {@link Service#getAllowAccountCreationFlag}
*/
public Future getAllowAccountCreationFlag(ResponseHandler callback);
/**
* Async version of {@link Service#getCatalog}
*/
public Future getCatalog();
/**
* Async callback version of {@link Service#getCatalog}
*/
public Future getCatalog(ResponseHandler callback);
/**
* Async version of {@link Service#getContacts}
*/
public Future> getContacts();
/**
* Async callback version of {@link Service#getContacts}
*/
public Future getContacts(ResponseHandler> callback);
/**
* Async version of {@link Service#getCustomerCountryLocationRestrictions}
*/
public Future> getCustomerCountryLocationRestrictions();
/**
* Async callback version of {@link Service#getCustomerCountryLocationRestrictions}
*/
public Future getCustomerCountryLocationRestrictions(ResponseHandler> callback);
/**
* Async version of {@link Service#getDistributor}
*/
public Future getDistributor();
/**
* Async callback version of {@link Service#getDistributor}
*/
public Future getDistributor(ResponseHandler callback);
/**
* Async version of {@link Service#getDistributorChildFlag}
*/
public Future getDistributorChildFlag();
/**
* Async callback version of {@link Service#getDistributorChildFlag}
*/
public Future getDistributorChildFlag(ResponseHandler callback);
/**
* Async version of {@link Service#getDistributorFlag}
*/
public Future getDistributorFlag();
/**
* Async callback version of {@link Service#getDistributorFlag}
*/
public Future getDistributorFlag(ResponseHandler callback);
/**
* Async version of {@link Service#getHardware}
*/
public Future> getHardware();
/**
* Async callback version of {@link Service#getHardware}
*/
public Future getHardware(ResponseHandler> callback);
/**
* Async version of {@link Service#getHasAgentSupportFlag}
*/
public Future getHasAgentSupportFlag();
/**
* Async callback version of {@link Service#getHasAgentSupportFlag}
*/
public Future getHasAgentSupportFlag(ResponseHandler callback);
/**
* Async version of {@link Service#getOpenTickets}
*/
public Future> getOpenTickets();
/**
* Async callback version of {@link Service#getOpenTickets}
*/
public Future getOpenTickets(ResponseHandler> callback);
/**
* Async version of {@link Service#getOwnedAccounts}
*/
public Future> getOwnedAccounts();
/**
* Async callback version of {@link Service#getOwnedAccounts}
*/
public Future getOwnedAccounts(ResponseHandler> callback);
/**
* Async version of {@link Service#getTicketGroups}
*/
public Future> getTicketGroups();
/**
* Async callback version of {@link Service#getTicketGroups}
*/
public Future getTicketGroups(ResponseHandler> callback);
/**
* Async version of {@link Service#getTickets}
*/
public Future> getTickets();
/**
* Async callback version of {@link Service#getTickets}
*/
public Future getTickets(ResponseHandler> callback);
/**
* Async version of {@link Service#getUsers}
*/
public Future> getUsers();
/**
* Async callback version of {@link Service#getUsers}
*/
public Future getUsers(ResponseHandler> callback);
/**
* Async version of {@link Service#getVirtualGuests}
*/
public Future> getVirtualGuests();
/**
* Async callback version of {@link Service#getVirtualGuests}
*/
public Future getVirtualGuests(ResponseHandler> callback);
}
public static class Mask extends Entity.Mask {
public Account.Mask account() {
return withSubMask("account", Account.Mask.class);
}
public Account.Mask allOwnedAccounts() {
return withSubMask("allOwnedAccounts", Account.Mask.class);
}
public Mask allowAccountCreationFlag() {
withLocalProperty("allowAccountCreationFlag");
return this;
}
public com.softlayer.api.service.product.Catalog.Mask catalog() {
return withSubMask("catalog", com.softlayer.api.service.product.Catalog.Mask.class);
}
public com.softlayer.api.service.brand.Contact.Mask contacts() {
return withSubMask("contacts", com.softlayer.api.service.brand.Contact.Mask.class);
}
public com.softlayer.api.service.brand.restriction.location.CustomerCountry.Mask customerCountryLocationRestrictions() {
return withSubMask("customerCountryLocationRestrictions", com.softlayer.api.service.brand.restriction.location.CustomerCountry.Mask.class);
}
public Brand.Mask distributor() {
return withSubMask("distributor", Brand.Mask.class);
}
public Mask distributorChildFlag() {
withLocalProperty("distributorChildFlag");
return this;
}
public Mask distributorFlag() {
withLocalProperty("distributorFlag");
return this;
}
public Hardware.Mask hardware() {
return withSubMask("hardware", Hardware.Mask.class);
}
public Mask hasAgentSupportFlag() {
withLocalProperty("hasAgentSupportFlag");
return this;
}
public Ticket.Mask openTickets() {
return withSubMask("openTickets", Ticket.Mask.class);
}
public Account.Mask ownedAccounts() {
return withSubMask("ownedAccounts", Account.Mask.class);
}
public com.softlayer.api.service.ticket.Group.Mask ticketGroups() {
return withSubMask("ticketGroups", com.softlayer.api.service.ticket.Group.Mask.class);
}
public Ticket.Mask tickets() {
return withSubMask("tickets", Ticket.Mask.class);
}
public com.softlayer.api.service.user.Customer.Mask users() {
return withSubMask("users", com.softlayer.api.service.user.Customer.Mask.class);
}
public com.softlayer.api.service.virtual.Guest.Mask virtualGuests() {
return withSubMask("virtualGuests", com.softlayer.api.service.virtual.Guest.Mask.class);
}
public Mask catalogId() {
withLocalProperty("catalogId");
return this;
}
public Mask id() {
withLocalProperty("id");
return this;
}
public Mask keyName() {
withLocalProperty("keyName");
return this;
}
public Mask longName() {
withLocalProperty("longName");
return this;
}
public Mask name() {
withLocalProperty("name");
return this;
}
public Mask allOwnedAccountCount() {
withLocalProperty("allOwnedAccountCount");
return this;
}
public Mask contactCount() {
withLocalProperty("contactCount");
return this;
}
public Mask customerCountryLocationRestrictionCount() {
withLocalProperty("customerCountryLocationRestrictionCount");
return this;
}
public Mask hardwareCount() {
withLocalProperty("hardwareCount");
return this;
}
public Mask openTicketCount() {
withLocalProperty("openTicketCount");
return this;
}
public Mask ownedAccountCount() {
withLocalProperty("ownedAccountCount");
return this;
}
public Mask ticketCount() {
withLocalProperty("ticketCount");
return this;
}
public Mask ticketGroupCount() {
withLocalProperty("ticketGroupCount");
return this;
}
public Mask userCount() {
withLocalProperty("userCount");
return this;
}
public Mask virtualGuestCount() {
withLocalProperty("virtualGuestCount");
return this;
}
}
}