Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2013 Ning, Inc.
   *
   * Ning licenses this file to you under the Apache License, version 2.0
   * (the "License"); you may not use this file except in compliance with the
   * License.  You may obtain a copy of the License at:
   *
   *    http://www.apache.org/licenses/LICENSE-2.0
   *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
  * License for the specific language governing permissions and limitations
  * under the License.
  */
 
 package org.killbill.billing.account.api;
 
 import java.util.List;
 import java.util.UUID;
 
The interface AccountUserApi offers APIs related to account operations.
 
 public interface AccountUserApi extends KillbillApi {

    

Parameters:
data the account data
context the user context
Returns:
the created Account
Throws:
AccountApiException
 
     public Account createAccount(AccountData dataCallContext contextthrows AccountApiException;

    
Updates the account by specifying the destination Account object

Parameters:
account account to be updated
context contains specific information about the call
Throws:
AccountApiException if a failure occurs
 
     public void updateAccount(Account accountCallContext contextthrows AccountApiException;

    
Updates the account by specifying the AccountData object

Parameters:
key account external key
context contains specific information about the call
Throws:
AccountApiException if a failure occurs
 
     public void updateAccount(String keyAccountData accountDataCallContext contextthrows AccountApiException;

    
Updates the account by specifying the AccountData object

Parameters:
accountId account unique id
context contains specific information about the call
Throws:
AccountApiException if a failure occurs
 
     public void updateAccount(UUID accountIdAccountData accountDataCallContext contextthrows AccountApiException;

    
Retrieves an account by specifying its external key.

Note that the system will enforce that only one account for a given external key exists in the system

Parameters:
key the externalKey for the account
context the user context
Returns:
the account
Throws:
AccountApiException if there is no such account
 
     public Account getAccountByKey(String keyTenantContext contextthrows AccountApiException;

    

Parameters:
accountId the unique id for the account
context the user context
Returns:
the account
Throws:
AccountApiException if there is no such account
 
     public Account getAccountById(UUID accountIdTenantContext contextthrows AccountApiException;

    
Find all accounts having their name, email, external_key or company_name matching the search key

Parameters:
searchKey the search key
offset the offset of the first result
limit the maximum number of results to retrieve
context the user context
Returns:
the list of accounts matching this search key for that tenant
 
     public Pagination<AccountsearchAccounts(String searchKeyLong offsetLong limitTenantContext context);

    

Parameters:
context the user context
offset the offset of the first result
limit the maximum number of results to retrieve
Returns:
the list of accounts for that tenant
    public Pagination<AccountgetAccounts(Long offsetLong limitTenantContext context);

    

Parameters:
externalKey the externalKey for the account
context the user context
Returns:
the unique id for that account
Throws:
AccountApiException if there is no such account
    public UUID getIdFromKey(String externalKeyTenantContext contextthrows AccountApiException;

    

Parameters:
accountId the account unique id
context the user context
Returns:
the laist of emails configured for that account
    public List<AccountEmailgetEmails(UUID accountIdTenantContext context);

    

Parameters:
accountId the account unique id
email the email to be added
context the user context
    public void addEmail(UUID accountIdAccountEmail emailCallContext contextthrows AccountApiException;

    

Parameters:
accountId the account unique id
email the email to be removed
context the user context
    public void removeEmail(UUID accountIdAccountEmail emailCallContext context);
New to GrepCode? Check out our FAQ X