RepresentationModel (ATG Java API)

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

```
public class RepresentationModel
extends java.lang.Object
```
Holder for various pieces of data required to support hypermedia formats, e.g. HAL, SIREN etc. Includes properties (version, class etc), links (self, next etc.), the representation state data itself and any embedded representations that should be included. An instance is created via the Builder, i.e. new RepresentationModel.Builder(). The builder methods are then used to populate the model and finally the build() method should be called to resolve it into a RepresentationModel instance.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RepresentationModel.Builder
Builder class used to create and validate representation models.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RepresentationModel.Builder` Builder class used to create and validate representation models.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string
`protected java.util.Map<java.lang.String,java.lang.Object>`	`mAdditionalState` Optional additional state that is stored under a given key
`protected RepresentationModel.Builder`	`mBuilder`
`protected boolean`	`mCrossRegistryURIs` Whether this model contains any uris that are for a registry other than the one currently in context.
`protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`mEmbedded` The map of embedded resource uri strings keyed by relation name.
`protected java.util.Set<java.lang.String>`	`mExcludeLinkRelations` The link relations to exclude in the representation model.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`mExtraParameters` Miscellaneous other parameters
`protected java.lang.String`	`mFilterUsed` Name of the actual filter used to output this model.
`protected <any>`	`mHeaders` HTTP Headers
`protected java.util.Map<java.lang.String,java.util.List<Link>>`	`mLinks` The link relations.
`protected ListingResponse`	`mListingResponse` Listing response
`protected java.util.List<Link>`	`mMembers` The list of member 'self' links of a collection.
`protected java.lang.String`	`mOverrideFilterId` The id of a filter override.
`protected java.util.Map<java.lang.String,java.lang.String>`	`mProperties` The properties in the representation model.
`protected java.lang.String`	`mResourceId` The resource id of the representation model.
`protected atg.service.jaxrs.ResourceType`	`mResourceType` The resource type of the representation model.
`protected java.net.URI`	`mResponseURI` If set, this is the uri that we will GET to respond to the current request.
`protected java.lang.Object`	`mState` The object being acted upon.
`protected int`	`mStatus` JAXRS Response status code
`protected int`	`mVersion` The resource version.

Constructor Summary

Constructors
Modifier Constructor and Description

protected RepresentationModel()
Default constructor.

Constructors
Modifier	Constructor and Description
`protected`	`RepresentationModel()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Map<java.lang.String,java.lang.Object>`	`getAdditionalState()` Get any additional state.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getEmbedded()` Get the map of embedded resource uri strings keyed by relation name.
`java.util.Set<java.lang.String>`	`getExcludeLinkRelations()` Get the link relations to exclude in the representation model.
`java.util.Map<java.lang.String,java.lang.Object>`	`getExtraParameters()` Miscellaneous other parameters
`java.lang.String`	`getFilterUsed()` Gets the filter used to write out this model.
`<any>`	`getHeaders()` Get the headers.
`java.util.Map<java.lang.String,java.util.List<Link>>`	`getLinks()` Get the link relations.
`ListingResponse`	`getListingResponse()` Get the listing response for a collection resources to provide pagination links and properties.
`java.util.List<Link>`	`getMembers()` Get the members of the representation model.
`java.lang.String`	`getOverrideFilterId()` Returns the id for the filter to override the default filter for the current resource
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Return the properties in the representation model.
`java.lang.String`	`getResourceId()` Return the resource id of the representation model.
`atg.service.jaxrs.ResourceType`	`getResourceType()` Return the resource type of the representation model.
`java.net.URI`	`getResponseURI()` Get the response uri.
`Link`	`getSelf()` Get the self link.
`java.lang.Object`	`getState()` Get the state object.
`int`	`getStatus()` Get the status code.
`int`	`getVersion()` Get the resource version.
`boolean`	`hasCrossRegistryURIs()`
`boolean`	`isSingular()` Utility method to determine if this representation is a singular or collection resource
`void`	`setFilterUsed(java.lang.String pFilterUsed)` Sets the filter used to write out this model.
`java.lang.String`	`toString()` Provide a user readable representation of the model.

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

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
    Class version string
  - mBuilder
```
protected RepresentationModel.Builder mBuilder
```
  - mState
```
protected java.lang.Object mState
```
    The object being acted upon. The state part of REST. Some object that represents a single resource that can be transformed by a MessageBodyWriter into standard json or xml. For example, the object could be a bean, dynamic bean (e.g. repository item), JSONObject, etc.
  - mAdditionalState
```
protected java.util.Map<java.lang.String,java.lang.Object> mAdditionalState
```
    Optional additional state that is stored under a given key
  - mResourceType
```
protected atg.service.jaxrs.ResourceType mResourceType
```
    The resource type of the representation model.
  - mResourceId
```
protected java.lang.String mResourceId
```
    The resource id of the representation model.
  - mExcludeLinkRelations
```
protected java.util.Set<java.lang.String> mExcludeLinkRelations
```
    The link relations to exclude in the representation model.
  - mProperties
```
protected java.util.Map<java.lang.String,java.lang.String> mProperties
```
    The properties in the representation model. E.g. version, class etc.
  - mLinks
```
protected java.util.Map<java.lang.String,java.util.List<Link>> mLinks
```
    The link relations.
  - mResponseURI
```
protected java.net.URI mResponseURI
```
    If set, this is the uri that we will GET to respond to the current request.
  - mMembers
```
protected java.util.List<Link> mMembers
```
    The list of member 'self' links of a collection.
  - mEmbedded
```
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> mEmbedded
```
    The map of embedded resource uri strings keyed by relation name.
  - mOverrideFilterId
```
protected java.lang.String mOverrideFilterId
```
    The id of a filter override.
  - mStatus
```
protected int mStatus
```
    JAXRS Response status code
  - mVersion
```
protected int mVersion
```
    The resource version.
  - mHeaders
```
protected <any> mHeaders
```
    HTTP Headers
  - mListingResponse
```
protected ListingResponse mListingResponse
```
    Listing response
  - mExtraParameters
```
protected java.util.Map<java.lang.String,java.lang.Object> mExtraParameters
```
    Miscellaneous other parameters
  - mFilterUsed
```
protected java.lang.String mFilterUsed
```
    Name of the actual filter used to output this model. Note, only populated during writing
  - mCrossRegistryURIs
```
protected boolean mCrossRegistryURIs
```
    Whether this model contains any uris that are for a registry other than the one currently in context.
- Constructor Detail
  - RepresentationModel
```
protected RepresentationModel()
```
    Default constructor.
- Method Detail
  - getResourceId
```
public java.lang.String getResourceId()
```
    Return the resource id of the representation model.
    
    Returns:
    
    the resource id
  - getResourceType
```
public atg.service.jaxrs.ResourceType getResourceType()
```
    Return the resource type of the representation model.
    
    Returns:
    
    the resource type
  - isSingular
```
public boolean isSingular()
```
    Utility method to determine if this representation is a singular or collection resource
    
    Returns:
    
    true if it is a singular resource representation
  - getExcludeLinkRelations
```
public java.util.Set<java.lang.String> getExcludeLinkRelations()
```
    Get the link relations to exclude in the representation model.
    
    Returns:
    
    the link relations or if null then an empty set is returned.
  - getProperties
```
public java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    Return the properties in the representation model.
    
    Returns:
    
    the properties.
  - getSelf
```
public Link getSelf()
```
    Get the self link.
    
    Returns:
    
    the self link, null if none exists.
  - getLinks
```
public java.util.Map<java.lang.String,java.util.List<Link>> getLinks()
```
    Get the link relations.
    
    Returns:
    
    the link relations.
  - hasCrossRegistryURIs
```
public boolean hasCrossRegistryURIs()
```
    Returns:
    
    true if this model has any uris for a registry other than the one currently in context.
  - getMembers
```
public java.util.List<Link> getMembers()
```
    Get the members of the representation model.
    
    Returns:
    
    the list of links to members.
  - getState
```
public java.lang.Object getState()
```
    Get the state object.
    
    Returns:
    
    the state object.
  - getAdditionalState
```
public java.util.Map<java.lang.String,java.lang.Object> getAdditionalState()
```
    Get any additional state.
    
    Returns:
    
    the additional state map
  - getEmbedded
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getEmbedded()
```
    Get the map of embedded resource uri strings keyed by relation name.
    
    Returns:
    
    the embedded resource uri strings.
  - getOverrideFilterId
```
public java.lang.String getOverrideFilterId()
```
    Returns the id for the filter to override the default filter for the current resource
    
    Returns:
    
    id of override filter
  - getStatus
```
public int getStatus()
```
    Get the status code.
    
    Returns:
    
    the status code.
  - getVersion
```
public int getVersion()
```
    Get the resource version.
    
    Returns:
    
    the resource version.
  - getHeaders
```
public <any> getHeaders()
```
    Get the headers.
    
    Returns:
    
    the headers.
  - getResponseURI
```
public java.net.URI getResponseURI()
```
    Get the response uri. If this is set then we will invoke a GET to this uri to retrieve a model to actually use to respond to the current request.
    However we will maintain the original 'self' link, headers and status code from this model.
    In addition, whatever filter is specified for the endpoint or on this model will also be used for the GET.
    Note: All other properties of this model will be ignored
    
    For example, if a POST addItem endpoint wants to respond with the updated collection of items then it can set this response uri to the collection uri and the final response could be the GET of that collection but also with this POST uri as the self link uri, a 201 response code and the header would include the location header.
    
    Returns:
    
    uri for a GET response
  - getListingResponse
```
public ListingResponse getListingResponse()
```
    Get the listing response for a collection resources to provide pagination links and properties.
    
    Returns:
    
    the listing response
  - getExtraParameters
```
public java.util.Map<java.lang.String,java.lang.Object> getExtraParameters()
```
    Miscellaneous other parameters
    
    Returns:
    
    map of extra parameters
  - getFilterUsed
```
public java.lang.String getFilterUsed()
```
    Gets the filter used to write out this model.
    
    Returns:
    
    filter
  - setFilterUsed
```
public void setFilterUsed(java.lang.String pFilterUsed)
```
    Sets the filter used to write out this model.
    
    Parameters:
    
    pFilterUsed - filter
  - toString
```
public java.lang.String toString()
```
    Provide a user readable representation of the model.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    info on the model.

Class RepresentationModel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

mBuilder

mState

mAdditionalState

mResourceType

mResourceId

mExcludeLinkRelations

mProperties

mLinks

mResponseURI

mMembers

mEmbedded

mOverrideFilterId

mStatus

mVersion

mHeaders

mListingResponse

mExtraParameters

mFilterUsed

mCrossRegistryURIs

Constructor Detail

RepresentationModel

Method Detail

getResourceId

getResourceType

isSingular

getExcludeLinkRelations

getProperties

getSelf

getLinks

hasCrossRegistryURIs

getMembers

getState

getAdditionalState

getEmbedded

getOverrideFilterId

getStatus

getVersion

getHeaders

getResponseURI

getListingResponse

getExtraParameters

getFilterUsed

setFilterUsed

toString