com.emc.vipr.client.catalog

Class Approvals2

java.lang.Object

com.emc.vipr.client.core.AbstractResources<T>

com.emc.vipr.client.core.AbstractBulkResources<T>

com.emc.vipr.client.catalog.AbstractCatalogBulkResources<ApprovalRestRep>

com.emc.vipr.client.catalog.Approvals2

All Implemented Interfaces:

BulkResources<ApprovalRestRep>, Resources<ApprovalRestRep>, TenantResources<ApprovalRestRep>

public class Approvals2
extends AbstractCatalogBulkResources<ApprovalRestRep>
implements TenantResources<ApprovalRestRep>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ORDER_ID_PARAM

Constructor Summary

Constructors

Constructor and Description
Approvals2(ViPRCatalogClient2 parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
java.util.List<ApprovalRestRep>	getByTenant(java.net.URI tenantId) Gets the resources associated with a given tenant.
java.util.List<ApprovalRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<ApprovalRestRep> filter) Gets the resources associated with a given tenant, optionally filtering the results as they are returned.
java.util.List<ApprovalRestRep>	getByUserTenant() Convenience method for retrieving by user's current tenant.
java.util.List<ApprovalRestRep>	getByUserTenant(ResourceFilter<ApprovalRestRep> filter) Convenience method for retrieving by user's current tenant.
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId) Lists resources associated with a given tenant.
java.util.List<NamedRelatedResourceRep>	listByUserTenant() Convenience method for listing by the user's current tenant.
ApprovalSearchBuilder	search() Creates a search builder specifically for creating approval search queries.
ApprovalRestRep	update(java.net.URI id, ApprovalUpdateParam input) Updates the given approval by ID.

Methods inherited from class com.emc.vipr.client.core.AbstractBulkResources

getByIds, getByRefs, listBulkIds

Methods inherited from class com.emc.vipr.client.core.AbstractResources

addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, updateTags, withInactive, withInternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.emc.vipr.client.core.BulkResources

getByIds, getByRefs

Methods inherited from interface com.emc.vipr.client.core.Resources

addTags, get, get, getTags, removeTags, updateTags

Field Detail

ORDER_ID_PARAM

public static final java.lang.String ORDER_ID_PARAM

See Also:

Constant Field Values

Constructor Detail

Approvals2

public Approvals2(ViPRCatalogClient2 parent,
                  RestClient client)

Method Detail

listByUserTenant

public java.util.List<NamedRelatedResourceRep> listByUserTenant()

Description copied from interface: TenantResources

Convenience method for listing by the user's current tenant.

Equivalent to: listByTenant(client.getUserTenant())

Specified by:

listByUserTenant in interface TenantResources<ApprovalRestRep>

See Also:

TenantResources.listByTenant(URI)

getByUserTenant

public java.util.List<ApprovalRestRep> getByUserTenant()

Description copied from interface: TenantResources

Convenience method for retrieving by user's current tenant.

Equivalent to: getByTenant(client.getUserTenant())

Specified by:

getByUserTenant in interface TenantResources<ApprovalRestRep>

See Also:

TenantResources.getByTenant(URI)

getByUserTenant

public java.util.List<ApprovalRestRep> getByUserTenant(ResourceFilter<ApprovalRestRep> filter)

Description copied from interface: TenantResources

Convenience method for retrieving by user's current tenant.

Equivalent to: getByTenant(client.getUserTenant(), filter)

Specified by:

getByUserTenant in interface TenantResources<ApprovalRestRep>

See Also:

TenantResources.getByTenant(URI, ResourceFilter)

listByTenant

public java.util.List<NamedRelatedResourceRep> listByTenant(java.net.URI tenantId)

Description copied from interface: TenantResources

Lists resources associated with a given tenant.

Specified by:

listByTenant in interface TenantResources<ApprovalRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resource references.

getByTenant

public java.util.List<ApprovalRestRep> getByTenant(java.net.URI tenantId)

Description copied from interface: TenantResources

Gets the resources associated with a given tenant.

Specified by:

getByTenant in interface TenantResources<ApprovalRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resources for this tenant.

See Also:

Resources.getByRefs(java.util.Collection)

getByTenant

public java.util.List<ApprovalRestRep> getByTenant(java.net.URI tenantId,
                                                   ResourceFilter<ApprovalRestRep> filter)

Description copied from interface: TenantResources

Gets the resources associated with a given tenant, optionally filtering the results as they are returned.

Specified by:

getByTenant in interface TenantResources<ApprovalRestRep>

Parameters:

tenantId - the tenant ID.

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

the list of resources for the tenant.

See Also:

Resources.getByRefs(java.util.Collection, ResourceFilter)

search

public ApprovalSearchBuilder search()

Creates a search builder specifically for creating approval search queries.

Specified by:

search in interface Resources<ApprovalRestRep>

Overrides:

search in class AbstractResources<ApprovalRestRep>

Returns:

a approval search builder.

update

public ApprovalRestRep update(java.net.URI id,
                              ApprovalUpdateParam input)

Updates the given approval by ID.

API Call: PUT /catalog/approvals/{id}

Parameters:

id - the ID of the approval to update.

input - the update configuration.

Returns:

the updated approval.