com.emc.vipr.client.catalog

Class Orders2

java.lang.Object

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

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

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

com.emc.vipr.client.catalog.Orders2

All Implemented Interfaces:

BulkResources<OrderRestRep>, Resources<OrderRestRep>, TenantResources<OrderRestRep>

public class Orders2
extends AbstractCatalogBulkResources<OrderRestRep>
implements TenantResources<OrderRestRep>

Constructor Summary

Constructors

Constructor and Description
Orders2(ViPRCatalogClient2 parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
void	cancelOrder(java.net.URI id) Cancel a scheduled order
void	cancelScheduledEvent(java.net.URI eventId) Cancellation an recurring event
void	deactivate(java.net.URI id) Deactivates the given order by ID.
void	deactivateScheduledEvent(java.net.URI eventId) Deactivate an recurring event
java.util.List<OrderRestRep>	getByTenant(java.net.URI tenantId) Gets the resources associated with a given tenant.
java.util.List<OrderRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<OrderRestRep> filter) Gets the resources associated with a given tenant, optionally filtering the results as they are returned.
java.util.List<OrderRestRep>	getByUserTenant() Convenience method for retrieving by user's current tenant.
java.util.List<OrderRestRep>	getByUserTenant(ResourceFilter<OrderRestRep> filter) Convenience method for retrieving by user's current tenant.
java.util.List<ExecutionLogRestRep>	getExecutionLogs(java.net.URI orderId) Return execution logs for an order
ExecutionStateRestRep	getExecutionState(java.net.URI orderId) Return execution state for an order
java.util.List<OrderLogRestRep>	getLogs(java.net.URI orderId) Return logs for an order
ScheduledEventRestRep	getScheduledEvent(java.net.URI eventId) Return scheduled event for an order
java.util.List<OrderRestRep>	getUserOrders() Return list of the current user's orders
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.
java.util.List<NamedRelatedResourceRep>	listUserOrders() Lists the currents user's orders
OrderSearchBuilder	search() Creates a search builder specifically for creating order search queries.
OrderRestRep	submit(OrderCreateParam input) Submit an order
OrderRestRep	submit(java.net.URI tenantId, java.net.URI serviceId, java.util.Map<java.lang.String,java.lang.String> params) Convenience method for submitting orders using a map of parameters.
ScheduledEventRestRep	submitScheduledEvent(ScheduledEventCreateParam input) Schedule an order
ScheduledEventRestRep	updateScheduledEvent(java.net.URI eventId, ScheduledEventUpdateParam input) Update an order

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

Constructor Detail

Orders2

public Orders2(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<OrderRestRep>

See Also:

TenantResources.listByTenant(URI)

getByUserTenant

public java.util.List<OrderRestRep> 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<OrderRestRep>

See Also:

TenantResources.getByTenant(URI)

getByUserTenant

public java.util.List<OrderRestRep> getByUserTenant(ResourceFilter<OrderRestRep> 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<OrderRestRep>

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<OrderRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resource references.

getByTenant

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

Description copied from interface: TenantResources

Gets the resources associated with a given tenant.

Specified by:

getByTenant in interface TenantResources<OrderRestRep>

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<OrderRestRep> getByTenant(java.net.URI tenantId,
                                                ResourceFilter<OrderRestRep> 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<OrderRestRep>

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 OrderSearchBuilder search()

Creates a search builder specifically for creating order search queries.

Specified by:

search in interface Resources<OrderRestRep>

Overrides:

search in class AbstractResources<OrderRestRep>

Returns:

a order search builder.

submit

public OrderRestRep submit(OrderCreateParam input)

Submit an order

API Call: POST /catalog/orders

Parameters:

input - the order

Returns:

the newly created order

submitScheduledEvent

public ScheduledEventRestRep submitScheduledEvent(ScheduledEventCreateParam input)

Schedule an order

API Call: POST /catalog/events

Parameters:

input - - event creation parameters

Returns:

the scheduled events

submit

public OrderRestRep submit(java.net.URI tenantId,
                           java.net.URI serviceId,
                           java.util.Map<java.lang.String,java.lang.String> params)

Convenience method for submitting orders using a map of parameters.

API Call: POST /catalog/orders

Parameters:

tenantId - Tenant ID to place the order in

serviceId - Service ID of the service to order

params - Map of parameters to place the order with

Returns:

the newly created order

listUserOrders

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

Lists the currents user's orders

API Call: GET /catalog/orders

Returns:

list of user orders

getUserOrders

public java.util.List<OrderRestRep> getUserOrders()

Return list of the current user's orders

API Call: GET /catalog/orders

Returns:

list of user orders

getExecutionState

public ExecutionStateRestRep getExecutionState(java.net.URI orderId)

Return execution state for an order

API Call: GET /catalog/orders/{id}/execution

Returns:

order's execution state

getExecutionLogs

public java.util.List<ExecutionLogRestRep> getExecutionLogs(java.net.URI orderId)

Return execution logs for an order

API Call: GET /catalog/orders/{id}/execution/logs

Returns:

order's execution logs

getLogs

public java.util.List<OrderLogRestRep> getLogs(java.net.URI orderId)

Return logs for an order

API Call: GET /catalog/orders/{id}/logs

Returns:

order's logs

cancelOrder

public void cancelOrder(java.net.URI id)

Cancel a scheduled order

API Call: POST /catalog/orders/{id}/cancel

deactivate

public void deactivate(java.net.URI id)

Deactivates the given order by ID.

API Call: POST /catalog/orders/{id}/deactivate

Parameters:

id - the ID of catalog order to deactivate.

getScheduledEvent

public ScheduledEventRestRep getScheduledEvent(java.net.URI eventId)

Return scheduled event for an order

API Call: GET /catalog/events/{id}

Returns:

order's logs

updateScheduledEvent

public ScheduledEventRestRep updateScheduledEvent(java.net.URI eventId,
                                                  ScheduledEventUpdateParam input)

Update an order

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

Parameters:

eventId - - URN for the event

input - - event update parameters

Returns:

the scheduled events

deactivateScheduledEvent

public void deactivateScheduledEvent(java.net.URI eventId)

Deactivate an recurring event

API Call: POST /catalog/events/{id}/deactivate

Parameters:

eventId - - URN for the event

cancelScheduledEvent

public void cancelScheduledEvent(java.net.URI eventId)

Cancellation an recurring event

API Call: POST /catalog/events/{id}/cancel

Parameters:

eventId - - URN for the event