br.gov.consumidor.consumidor.api

Class ConsumidorAPI

java.lang.Object

br.gov.consumidor.consumidor.api.ConsumidorAPI

public final class ConsumidorAPI
extends Object

Classe principal da API. A partir dela, pode-se escolher um conjunto de ações possíveis, como acessar itens de segurança ou consultar dados.

Author:

João Paulo Sossoloti.

Method Summary

Modifier and Type	Method and Description
AlterarReclamacoesAPI	alterarReclamacoes() Acessa os itens sobre alterações em reclamações.
AlterarReclamacoesAPI	alterarReclamacoes(Long cpfAutorizado) Acessa os itens sobre alterações em reclamações.
ConfiguracaoAPI	configuracao() Acessa os itens sobre configuracoes da API.
CadastrosBasicosAPI	consultarCadastrosBasicos() Acessa os itens sobre consultas nos cadastros básicos.
CadastrosBasicosAPI	consultarCadastrosBasicos(Long cpfAutorizado) Acessa os itens sobre consultas nos cadastros básicos.
ConsultarReclamacoesAPI	consultarReclamacoes() Acessa os itens sobre consultas de reclamações.
ConsultarReclamacoesAPI	consultarReclamacoes(Long cpfAutorizado) Acessa os itens sobre consultas de reclamações.
static ConsumidorAPI	instance() Retorna a propria instancia Singleton.
SegurancaAPI	seguranca() Acessa os itens sobre segurança e token.

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static ConsumidorAPI instance()

Retorna a propria instancia Singleton.

Returns:

ConsumidorAPI.

seguranca

public SegurancaAPI seguranca()

Acessa os itens sobre segurança e token.

Returns:

SegurancaAPI.

configuracao

public ConfiguracaoAPI configuracao()

Acessa os itens sobre configuracoes da API. Essas configurações são opcionais, sendo que seus valores já estão predeterminadas automaticamente.

Returns:

ConfiguracaoAPI.

consultarCadastrosBasicos

public CadastrosBasicosAPI consultarCadastrosBasicos(Long cpfAutorizado)
                                              throws ParametrosAPIException

Acessa os itens sobre consultas nos cadastros básicos.

Parameters:

cpfAutorizado - String com o cpf do usuário autorizado.

Returns:

CadastrosBasicosAPI.

Throws:

ParametrosAPIException

consultarCadastrosBasicos

public CadastrosBasicosAPI consultarCadastrosBasicos()

Acessa os itens sobre consultas nos cadastros básicos.

Returns:

CadastrosBasicosAPI.

consultarReclamacoes

public ConsultarReclamacoesAPI consultarReclamacoes(Long cpfAutorizado)
                                             throws ParametrosAPIException

Acessa os itens sobre consultas de reclamações.

Parameters:

cpfAutorizado - String com o cpf do usuário autorizado.

Returns:

ConsultarReclamacoesAPI.

Throws:

ParametrosAPIException

consultarReclamacoes

public ConsultarReclamacoesAPI consultarReclamacoes()

Acessa os itens sobre consultas de reclamações.

Returns:

ConsultarReclamacoesAPI.

alterarReclamacoes

public AlterarReclamacoesAPI alterarReclamacoes(Long cpfAutorizado)
                                         throws ParametrosAPIException

Acessa os itens sobre alterações em reclamações.

Parameters:

cpfAutorizado - String com o cpf do usuário autorizado.

Returns:

AlterarReclamacoesAPI.

Throws:

ParametrosAPIException

alterarReclamacoes

public AlterarReclamacoesAPI alterarReclamacoes()

Acessa os itens sobre alterações em reclamações.

Returns:

AlterarReclamacoesAPI.