PlanClient (Step Enterprise 3.21.0 API)

java.lang.Object
- step.client.AbstractRemoteClient
- - step.client.PlanClient

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class PlanClient
extends step.client.AbstractRemoteClient
```
This class is a facade to the Plan REST services

Field Summary
- Fields inherited from class step.client.AbstractRemoteClient
  client, cookies, credentials

Constructor Summary

Constructors
Constructor Description

PlanClient()

PlanClient(step.client.credentials.ControllerCredentials credentials)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`step.core.plans.Plan`	`findByAttributes(Map<String,String> attributes)`
`List<step.core.plans.Plan>`	`findManyByAttributes(Map<String,String> attributes)`
`step.core.plans.Plan`	`get(String planId)`
`void`	`remove(String planId)`
`step.core.plans.Plan`	`save(step.core.plans.Plan plan)`

Methods inherited from class step.client.AbstractRemoteClient
close, executeRequest, notImplemented, requestBuilder, requestBuilder

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PlanClient
```
public PlanClient(step.client.credentials.ControllerCredentials credentials)
```
  - PlanClient
```
public PlanClient()
```
- Method Detail
  - get
```
public step.core.plans.Plan get(String planId)
```
    Parameters:
    
    planId - the id of the plan to be retrieved
    
    Returns:
    
    the plan with the given id. This is subject to object filtering: be sure to select the appropriate tenant first
  - save
```
public step.core.plans.Plan save(step.core.plans.Plan plan)
```
    Parameters:
    
    plan - the plan instance to be saved. This method is subject to object enrichment.
    
    Returns:
    
    the plan instance after enrichment.
  - findByAttributes
```
public step.core.plans.Plan findByAttributes(Map<String,String> attributes)
```
    Parameters:
    
    attributes - the mandatory attributes to search for
    
    Returns:
    
    the first plan matching the given attributes. This is subject to object filtering: be sure to select the appropriate tenant first
  - findManyByAttributes
```
public List<step.core.plans.Plan> findManyByAttributes(Map<String,String> attributes)
```
  - remove
```
public void remove(String planId)
```
    Parameters:
    
    planId - the id of the plan to be removed.