RepresentationModel.Builder (ATG Java API)

java.lang.Object
- atg.service.jaxrs.RepresentationModel.Builder

Enclosing class:

RepresentationModel
```
public static class RepresentationModel.Builder
extends java.lang.Object
```
Builder class used to create and validate representation models.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RepresentationModel.Builder`	`accepted()` Set the http status saying 'accepted'.
`RepresentationModel.Builder`	`additionalState(java.lang.String pKey, java.lang.Object pState)` Add additional state with the given key field.
`RepresentationModel`	`build()` Create a RepresentationModel using the data already stored in the builder.
`RepresentationModel.Builder`	`created(java.net.URI pLocation)` Set the location http header to the location passed in and the status to 'created'.
`RepresentationModel.Builder`	`crossRegistryURIs(boolean pCrossRegistryURIs)`
`RepresentationModel.Builder`	`embedded(java.lang.String pRel, java.lang.String... pEmbedded)` Add embedded resources.
`RepresentationModel.Builder`	`excludeLinkRelations(java.lang.String... pLinkRelations)` Add link relations to exclude.
`RepresentationModel.Builder`	`extraParameter(java.lang.String pKey, java.lang.Object pValue)` Adds an extra parameter to the map.
`static RepresentationModel.Builder`	`fromModel(RepresentationModel pRepresentationModel)` Static utility method to create a new builder from a given model.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getEmbedded()` Get the embedded resources.
`java.util.Set<java.lang.String>`	`getExcludeLinkRelations()` Get the links to exclude.
`java.util.Map<java.lang.String,java.lang.Object>`	`getExtraParameters()` Get the map of extra parameters.
`<any>`	`getHeaders()` Get the http headers.
`java.util.Map<java.lang.String,java.util.List<Link>>`	`getLinks()` Get the links.
`ListingResponse`	`getListingResponse()` Get the listing response
`java.util.List<Link>`	`getMembers()` Get the members.
`java.lang.String`	`getOverrideFilterId()` Get the filter override id.
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Get the properties.
`java.lang.String`	`getResourceId()` Get the resource id.
`atg.service.jaxrs.ResourceType`	`getResourceType()` Get the resource type.
`java.net.URI`	`getResponseURI()` Get the response uri.
`java.lang.Object`	`getState()` Get the state.
`int`	`getStatus()` Get the current http status.
`int`	`getVersion()` Get the resource version.
`boolean`	`hasCrossRegistryURIs()` Get whether the model has cross registry uri references.
`RepresentationModel.Builder`	`header(java.lang.String pName, java.lang.Object pValue)` Set a header in the http headers.
`RepresentationModel.Builder`	`language(java.util.Locale pLanguage)` Set the language header in the http headers.
`RepresentationModel.Builder`	`links(Link... pLinks)` Method to add the links provided to the map of links.
`RepresentationModel.Builder`	`listingResponse(ListingResponse pListingResponse)` Sets the listing response to use for a collection resource representation.
`RepresentationModel.Builder`	`location(java.net.URI pLocation)` Set the location header in the http headers.
`RepresentationModel.Builder`	`members(Link... pMemberLinks)` Add links to the collection of members.
`RepresentationModel.Builder`	`overrideFilterId(java.lang.String pOverrideFilterId)` Set the Override Filter Id
`RepresentationModel.Builder`	`properties(java.util.Map<java.lang.String,java.lang.String> pProperties)` Add a map of properties.
`RepresentationModel.Builder`	`property(java.lang.String pKey, java.lang.String pValue)` Store a key-value property.
`RepresentationModel.Builder`	`removeAdditionalState(java.lang.String pKey)` Remove the additional state for the given key
`RepresentationModel.Builder`	`removeEmbedded(java.lang.String pRel)` Method to remove the embedded uris for the given rel.
`RepresentationModel.Builder`	`removeExtraParameter(java.lang.String pKey)` Removes an entry from the extra parameters map for the given key
`RepresentationModel.Builder`	`removeHeader(java.lang.String pName)` Remove all headers for the given name
`RepresentationModel.Builder`	`removeLinks(Link... pLinks)` Method to remove the links specified from the map of links.
`RepresentationModel.Builder`	`removeProperty(java.lang.String pKey)` Remove the property for the given key
`RepresentationModel.Builder`	`replaceEmbedded(java.util.Map<java.lang.String,java.util.List<java.lang.String>> pEmbedded)` Replace the map of embedded uris with the given map
`RepresentationModel.Builder`	`replaceExcludeLinkRelations(java.util.Set<java.lang.String> pLinkRelations)` Replace the collection of excluded link relations with the given collection
`RepresentationModel.Builder`	`replaceExtraParameters(java.util.Map<java.lang.String,java.lang.Object> pExtraParameters)` Replaces the extra parameters map with the given map
`RepresentationModel.Builder`	`replaceHeaders(<any> pHeaders)` Replace the map of headers with the given map.
`RepresentationModel.Builder`	`replaceLinks(java.util.Map<java.lang.String,java.util.List<Link>> pLinks)` Add links to the collection of links in the builder.
`RepresentationModel.Builder`	`replaceMembers(java.util.List<Link> pMemberLinks)` Replace the collection of member links with the given collection.
`RepresentationModel.Builder`	`replaceProperties(java.util.Map<java.lang.String,java.lang.String> pProperties)` Replace the map of properties with the given map
`RepresentationModel.Builder`	`resourceId(java.lang.String pResourceId)` Set the resource id.
`RepresentationModel.Builder`	`resourceType(atg.service.jaxrs.ResourceType pResourceType)` Set the resource type.
`RepresentationModel.Builder`	`responseURI(java.lang.String pURIPath)` Set the response uri with a uri string.
`RepresentationModel.Builder`	`responseURI(java.net.URI pURI)` Set the response ur.
`RepresentationModel.Builder`	`self(Link pSelf)` Set a self link.
`RepresentationModel.Builder`	`serverError()` Set the http status saying there was a server error.
`RepresentationModel.Builder`	`state(java.lang.Object pState)` Set the state object to the object passed in.
`RepresentationModel.Builder`	`status(int pStatus)` Set the http status to the status passed in.
`RepresentationModel.Builder`	`status(Response.Status pStatus)` Set the http status to the status passed in.
`RepresentationModel.Builder`	`version(int pVersion)` Set the resource version.

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - fromModel
```
public static RepresentationModel.Builder fromModel(RepresentationModel pRepresentationModel)
```
    Static utility method to create a new builder from a given model.
    
    Parameters:
    
    pRepresentationModel - model to base the new builder on
    
    Returns:
    
    builder populated from the given model
  - getState
```
public java.lang.Object getState()
```
    Get the state.
    
    Returns:
    
    the state.
  - getProperties
```
public java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    Get the properties.
    
    Returns:
    
    the properties.
  - getLinks
```
public java.util.Map<java.lang.String,java.util.List<Link>> getLinks()
```
    Get the links.
    
    Returns:
    
    the links.
  - getEmbedded
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getEmbedded()
```
    Get the embedded resources.
    
    Returns:
    
    the resources.
  - getResourceType
```
public atg.service.jaxrs.ResourceType getResourceType()
```
    Get the resource type.
    
    Returns:
    
    The type.
  - getResourceId
```
public java.lang.String getResourceId()
```
    Get the resource id.
    
    Returns:
    
    The id.
  - getExcludeLinkRelations
```
public java.util.Set<java.lang.String> getExcludeLinkRelations()
```
    Get the links to exclude.
    
    Returns:
    
    the links.
  - getOverrideFilterId
```
public java.lang.String getOverrideFilterId()
```
    Get the filter override id.
    
    Returns:
    
    the id.
  - getStatus
```
public int getStatus()
```
    Get the current http status.
    
    Returns:
    
    the status.
  - getVersion
```
public int getVersion()
```
    Get the resource version.
    
    Returns:
    
    the version.
  - getHeaders
```
public <any> getHeaders()
```
    Get the http headers.
    
    Returns:
    
    the headers.
  - getResponseURI
```
public java.net.URI getResponseURI()
```
    Get the response uri.
    
    Returns:
    
    the response uri
  - getMembers
```
public java.util.List<Link> getMembers()
```
    Get the members.
    
    Returns:
    
    the members.
  - hasCrossRegistryURIs
```
public boolean hasCrossRegistryURIs()
```
    Get whether the model has cross registry uri references.
    
    Returns:
    
    true if it has uris for a registry other than the one in context.
  - getListingResponse
```
public ListingResponse getListingResponse()
```
    Get the listing response
    
    Returns:
    
    the listing response
  - getExtraParameters
```
public java.util.Map<java.lang.String,java.lang.Object> getExtraParameters()
```
    Get the map of extra parameters.
    
    Returns:
    
    map of extra parameters
  - build
```
public RepresentationModel build()
```
    Create a RepresentationModel using the data already stored in the builder.
    
    Returns:
    
    the populated representation model.
  - language
```
public RepresentationModel.Builder language(java.util.Locale pLanguage)
```
    Set the language header in the http headers.
    
    Parameters:
    
    pLanguage - the language.
    
    Returns:
    
    the updated builder object.
  - location
```
public RepresentationModel.Builder location(java.net.URI pLocation)
```
    Set the location header in the http headers.
    
    Parameters:
    
    pLocation - the location.
    
    Returns:
    
    the updated builder object.
  - header
```
public RepresentationModel.Builder header(java.lang.String pName,
                                          java.lang.Object pValue)
```
    Set a header in the http headers.
    
    Parameters:
    
    pName - the name of the header.
    
    pValue - the value of the header.
    
    Returns:
    
    the updated builder object.
  - removeHeader
```
public RepresentationModel.Builder removeHeader(java.lang.String pName)
```
    Remove all headers for the given name
    
    Parameters:
    
    pName - name of Headers to remove
    
    Returns:
    
    the updated builder object.
  - replaceHeaders
```
public RepresentationModel.Builder replaceHeaders(<any> pHeaders)
```
    Replace the map of headers with the given map.
    
    Parameters:
    
    pHeaders - Map to replace the headers with
    
    Returns:
    
    the updated builder object.
  - created
```
public RepresentationModel.Builder created(java.net.URI pLocation)
```
    Set the location http header to the location passed in and the status to 'created'.
    
    Parameters:
    
    pLocation - the location of resource.
    
    Returns:
    
    the updated builder object.
  - serverError
```
public RepresentationModel.Builder serverError()
```
    Set the http status saying there was a server error.
    
    Returns:
    
    the updated builder object.
  - accepted
```
public RepresentationModel.Builder accepted()
```
    Set the http status saying 'accepted'.
    
    Returns:
    
    the updated builder object.
  - status
```
public RepresentationModel.Builder status(int pStatus)
```
    Set the http status to the status passed in.
    
    Parameters:
    
    pStatus - the status.
    
    Returns:
    
    the updated builder object.
  - status
```
public RepresentationModel.Builder status(Response.Status pStatus)
```
    Set the http status to the status passed in.
    
    Parameters:
    
    pStatus - the status.
    
    Returns:
    
    the updated builder object.
  - state
```
public RepresentationModel.Builder state(java.lang.Object pState)
```
    Set the state object to the object passed in.
    
    Parameters:
    
    pState - the object to act upon.
    
    Returns:
    
    the updated builder object.
  - additionalState
```
public RepresentationModel.Builder additionalState(java.lang.String pKey,
                                                   java.lang.Object pState)
```
    Add additional state with the given key field.
    
    Parameters:
    
    pKey - String key the additional state will be stored under
    
    pState - State object
    
    Returns:
    
    the updated builder object
  - removeAdditionalState
```
public RepresentationModel.Builder removeAdditionalState(java.lang.String pKey)
```
    Remove the additional state for the given key
    
    Parameters:
    
    pKey - key of the additional state to remove
    
    Returns:
    
    the updated builder object.
  - version
```
public RepresentationModel.Builder version(int pVersion)
```
    Set the resource version.
    
    Parameters:
    
    pVersion - the version.
    
    Returns:
    
    the updated builder object.
  - property
```
public RepresentationModel.Builder property(java.lang.String pKey,
                                            java.lang.String pValue)
```
    Store a key-value property.
    
    Parameters:
    
    pKey - the key.
    
    pValue - the value.
    
    Returns:
    
    the updated builder object.
  - removeProperty
```
public RepresentationModel.Builder removeProperty(java.lang.String pKey)
```
    Remove the property for the given key
    
    Parameters:
    
    pKey - key of the property to remove
    
    Returns:
    
    the updated builder object.
  - properties
```
public RepresentationModel.Builder properties(java.util.Map<java.lang.String,java.lang.String> pProperties)
```
    Add a map of properties.
    
    Parameters:
    
    pProperties - the properties to add.
    
    Returns:
    
    the updated builder object.
  - replaceProperties
```
public RepresentationModel.Builder replaceProperties(java.util.Map<java.lang.String,java.lang.String> pProperties)
```
    Replace the map of properties with the given map
    
    Parameters:
    
    pProperties - new map of properties to use
    
    Returns:
    
    the updated builder object.
  - replaceLinks
```
public RepresentationModel.Builder replaceLinks(java.util.Map<java.lang.String,java.util.List<Link>> pLinks)
```
    Add links to the collection of links in the builder.
    
    Parameters:
    
    pLinks - the links to add.
    
    Returns:
    
    the updated builder object.
  - links
```
public RepresentationModel.Builder links(Link... pLinks)
```
    Method to add the links provided to the map of links.
    
    Parameters:
    
    pLinks - the links to add.
    
    Returns:
    
    the updated builder object.
  - removeLinks
```
public RepresentationModel.Builder removeLinks(Link... pLinks)
```
    Method to remove the links specified from the map of links.
    
    Parameters:
    
    pLinks - the links to remove.
    
    Returns:
    
    the updated builder object.
  - self
```
public RepresentationModel.Builder self(Link pSelf)
```
    Set a self link.
    
    Parameters:
    
    pSelf - the self link.
    
    Returns:
    
    the updated builder object.
  - embedded
```
public RepresentationModel.Builder embedded(java.lang.String pRel,
                                            java.lang.String... pEmbedded)
```
    Add embedded resources.
    
    Parameters:
    
    pRel - the relation name to the embedded resource.
    
    pEmbedded - the embedded resource uri strings
    
    Returns:
    
    the updated builder object.
  - removeEmbedded
```
public RepresentationModel.Builder removeEmbedded(java.lang.String pRel)
```
    Method to remove the embedded uris for the given rel.
    
    Parameters:
    
    pRel - relation name of embedded uris to remove
    
    Returns:
    
    the updated builder object.
  - replaceEmbedded
```
public RepresentationModel.Builder replaceEmbedded(java.util.Map<java.lang.String,java.util.List<java.lang.String>> pEmbedded)
```
    Replace the map of embedded uris with the given map
    
    Parameters:
    
    pEmbedded - Map of embedded uris keyed by relation name
    
    Returns:
    
    the updated builder object.
  - resourceId
```
public RepresentationModel.Builder resourceId(java.lang.String pResourceId)
```
    Set the resource id.
    
    Parameters:
    
    pResourceId - the resource id.
    
    Returns:
    
    the updated builder object.
  - resourceType
```
public RepresentationModel.Builder resourceType(atg.service.jaxrs.ResourceType pResourceType)
```
    Set the resource type.
    
    Parameters:
    
    pResourceType - the resource type.
    
    Returns:
    
    the updated builder object.
  - excludeLinkRelations
```
public RepresentationModel.Builder excludeLinkRelations(java.lang.String... pLinkRelations)
```
    Add link relations to exclude.
    
    Parameters:
    
    pLinkRelations - the link relations to exclude.
    
    Returns:
    
    the updated builder object.
  - replaceExcludeLinkRelations
```
public RepresentationModel.Builder replaceExcludeLinkRelations(java.util.Set<java.lang.String> pLinkRelations)
```
    Replace the collection of excluded link relations with the given collection
    
    Parameters:
    
    pLinkRelations - new excluded link relations to use
    
    Returns:
    
    the updated builder object.
  - overrideFilterId
```
public RepresentationModel.Builder overrideFilterId(java.lang.String pOverrideFilterId)
```
    Set the Override Filter Id
    
    Parameters:
    
    pOverrideFilterId - override filter id
    
    Returns:
    
    the updated builder object.
  - responseURI
```
public RepresentationModel.Builder responseURI(java.lang.String pURIPath)
```
    Set the response uri with a uri string.
    
    Parameters:
    
    pURIPath - string uri path
    
    Returns:
    
    the updated builder object
  - responseURI
```
public RepresentationModel.Builder responseURI(java.net.URI pURI)
```
    Set the response ur.
    
    Parameters:
    
    pURI - uri
    
    Returns:
    
    the updated builder object
  - crossRegistryURIs
```
public RepresentationModel.Builder crossRegistryURIs(boolean pCrossRegistryURIs)
```
  - members
```
public RepresentationModel.Builder members(Link... pMemberLinks)
```
    Add links to the collection of members.
    
    Parameters:
    
    pMemberLinks - the member self links.
    
    Returns:
    
    the updated builder object.
  - replaceMembers
```
public RepresentationModel.Builder replaceMembers(java.util.List<Link> pMemberLinks)
```
    Replace the collection of member links with the given collection.
    
    Parameters:
    
    pMemberLinks - new collection of self links for members
    
    Returns:
    
    the updated builder object.
  - listingResponse
```
public RepresentationModel.Builder listingResponse(ListingResponse pListingResponse)
```
    Sets the listing response to use for a collection resource representation. This allows pagination links and properties to be included in the response.
    
    Parameters:
    
    pListingResponse - ListingResponse to use.
    
    Returns:
    
    the updated builder object.
  - extraParameter
```
public RepresentationModel.Builder extraParameter(java.lang.String pKey,
                                                  java.lang.Object pValue)
```
    Adds an extra parameter to the map. This map is for general extensibility usage.
    
    Parameters:
    
    pKey - key of parameter to add
    
    pValue - value of parameter to add
    
    Returns:
    
    the updated builder object
  - replaceExtraParameters
```
public RepresentationModel.Builder replaceExtraParameters(java.util.Map<java.lang.String,java.lang.Object> pExtraParameters)
```
    Replaces the extra parameters map with the given map
    
    Parameters:
    
    pExtraParameters - new extra parameters map to use
    
    Returns:
    
    the updated builder object
  - removeExtraParameter
```
public RepresentationModel.Builder removeExtraParameter(java.lang.String pKey)
```
    Removes an entry from the extra parameters map for the given key
    
    Parameters:
    
    pKey - key of the entry to remove
    
    Returns:
    
    the updated builder object

Class RepresentationModel.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

fromModel

getState

getProperties

getLinks

getEmbedded

getResourceType

getResourceId

getExcludeLinkRelations

getOverrideFilterId

getStatus

getVersion

getHeaders

getResponseURI

getMembers

hasCrossRegistryURIs

getListingResponse

getExtraParameters

build

language

location

header

removeHeader

replaceHeaders

created

serverError

accepted

status

status

state

additionalState

removeAdditionalState

version

property

removeProperty

properties

replaceProperties

replaceLinks

links

removeLinks

self

embedded

removeEmbedded

replaceEmbedded

resourceId

resourceType

excludeLinkRelations

replaceExcludeLinkRelations

overrideFilterId

responseURI

responseURI

crossRegistryURIs

members

replaceMembers

listingResponse

extraParameter

replaceExtraParameters

removeExtraParameter