atg.service.jaxrs.restresources

Interface UpdateableRestResource

All Known Implementing Classes:

CartCommerceItemRestSubresource, CartPaymentGroupRestSubresource, CartRestResource, CartShippingGroupRestSubresource, CurrentUserAddressRestSubresource, CurrentUserRestResource

public interface UpdateableRestResource

Interface that allows resources to update either a collection of items or a singular item. Each implementing method will act upon the information contained within the UpdateInfo @see atg.service.jaxrs.ResourceUpdateInfo.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
java.net.URI	update(atg.service.jaxrs.ResourceUpdateInfo pRestResourceUpdateInfo) The update method allows a resource to obtain its own items on which to preform its given action.
default java.net.URI	updateEmbeddedResources(atg.service.jaxrs.ResourceUpdateInfo pUpdateInfo, java.util.Properties pEmbeddedResources) This method attempts to call update() for each of the embedded resources contained within pEmbeddedResources.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

update

java.net.URI update(atg.service.jaxrs.ResourceUpdateInfo pRestResourceUpdateInfo)
             throws RestException

The update method allows a resource to obtain its own items on which to preform its given action. A resource primarily acts upon a collection or a single item

Parameters:

pRestResourceUpdateInfo - - update object containing request input and any existing repository data to be updated

Returns:

URI - self link to any newly created item, or null if none created

Throws:

RestException - - if an issue occurs performing the update

updateEmbeddedResources

default java.net.URI updateEmbeddedResources(atg.service.jaxrs.ResourceUpdateInfo pUpdateInfo,
                                             java.util.Properties pEmbeddedResources)
                                      throws RestException

This method attempts to call update() for each of the embedded resources contained within pEmbeddedResources. This default method should be called from within implementing classes, if updateable embedded resources are to be invoked.

Parameters:

pUpdateInfo - - updateInfo object containing the update data for the top level resource

pEmbeddedResources - - key/value mappings of embedded resource name/resource id

Returns:

URI - the URI of a created item, if an item is created as part of the update operation

Throws:

RestException - if a problem occurs updating the embeddedResources