com.gooddata.sdk.service.account

Class AccountService

java.lang.Object

com.gooddata.sdk.service.AbstractService

com.gooddata.sdk.service.account.AccountService

public class AccountService
extends AbstractService

Service to access and manipulate account.

Nested Class Summary

Nested classes/interfaces inherited from class com.gooddata.sdk.service.AbstractService

AbstractService.OutputStreamResponseExtractor

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.springframework.web.util.UriTemplate	ACCOUNT_TEMPLATE
protected static org.springframework.web.util.UriTemplate	ACCOUNTS_TEMPLATE
protected static org.springframework.web.util.UriTemplate	LOGIN_TEMPLATE
protected static org.springframework.web.util.UriTemplate	SEPARATORS_TEMPLATE

Fields inherited from class com.gooddata.sdk.service.AbstractService

mapper, restTemplate

Constructor Summary

Constructors

Constructor and Description
AccountService(org.springframework.web.client.RestTemplate restTemplate, GoodDataSettings settings) Constructs service for GoodData account management.

Method Summary

Modifier and Type	Method and Description
Account	createAccount(Account account, String organizationName) Creates new account in given organization (domain).
Account	getAccountById(String id) Get account for given account id
Account	getAccountByUri(String uri) Get account for given account id
Account	getCurrent() Gets current account of logged user.
SeparatorSettings	getSeparatorSettings(Account account) Returns default thousand and decimal separator settings for the given account.
void	logout() Performs user logout.
void	removeAccount(Account account) Delete given account
void	updateAccount(Account account) Updates account

Methods inherited from class com.gooddata.sdk.service.AbstractService

extractData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACCOUNT_TEMPLATE

protected static final org.springframework.web.util.UriTemplate ACCOUNT_TEMPLATE

ACCOUNTS_TEMPLATE

protected static final org.springframework.web.util.UriTemplate ACCOUNTS_TEMPLATE

LOGIN_TEMPLATE

protected static final org.springframework.web.util.UriTemplate LOGIN_TEMPLATE

SEPARATORS_TEMPLATE

protected static final org.springframework.web.util.UriTemplate SEPARATORS_TEMPLATE

Constructor Detail

AccountService

public AccountService(org.springframework.web.client.RestTemplate restTemplate,
                      GoodDataSettings settings)

Constructs service for GoodData account management.

Parameters:

restTemplate - RESTful HTTP Spring template

settings - settings

Method Detail

getCurrent

public Account getCurrent()

Gets current account of logged user.

Returns:

current account

Throws:

com.gooddata.GoodDataException - when current account can't be accessed.

logout

public void logout()

Performs user logout.

Throws:

com.gooddata.GoodDataException - when logout failed.

createAccount

public Account createAccount(Account account,
                             String organizationName)

Creates new account in given organization (domain). Only domain admin is allowed create new accounts! This means rest request has to authorized as domain admin.

Parameters:

account - to create

organizationName - (domain) in which account should be created

Returns:

new account

Throws:

com.gooddata.GoodDataException - when account can't be created

removeAccount

public void removeAccount(Account account)

Delete given account

Parameters:

account - to remove

Throws:

AccountNotFoundException - when given account wasn't found

com.gooddata.GoodDataException - when account can't be removed for other reason

getAccountById

public Account getAccountById(String id)

Get account for given account id

Parameters:

id - to search for

Returns:

account for id

Throws:

AccountNotFoundException - when account for given id can't be found

com.gooddata.GoodDataException - when different error occurs

getAccountByUri

public Account getAccountByUri(String uri)

Get account for given account id

Parameters:

uri - to search for

Returns:

account for uri

Throws:

AccountNotFoundException - when account for given uri can't be found

com.gooddata.GoodDataException - when different error occurs

updateAccount

public void updateAccount(Account account)

Updates account

Parameters:

account - to be updated

Throws:

AccountNotFoundException - when account for given uri can't be found

getSeparatorSettings

public SeparatorSettings getSeparatorSettings(Account account)

Returns default thousand and decimal separator settings for the given account.

Parameters:

account - account

Returns:

default SeparatorSettings for the account