org.talares.datatypes.items

Class ComponentPresentation

java.lang.Object

org.talares.datatypes.items.Item

org.talares.datatypes.items.ComponentPresentation

public class ComponentPresentation
extends Item

A Java representation of a ComponentPresentation content type. Example Json:

  {
    "__metadata": {
      "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/ComponentPresentations(PublicationId=1,ComponentId=123,TemplateId=1234)",
      "type": "Tridion.ContentDelivery.ComponentPresentation"
    },
    "ComponentId": 123,
    "OutputFormat": "HTML Fragment",
    "PresentationContent": "
Some content
",
    "PublicationId": 1,
    "TemplateId": 123,
    "Component": {
     "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/ComponentPresentations(PublicationId=1,ComponentId=123,TemplateId=1234)/Component"
      }
    },
    "Template": {
      "__deferred": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/ComponentPresentations(PublicationId=1,ComponentId=123,TemplateId=1234)/Template"
      }
    },
    "Pages": {
      "__deferred": {
         "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/ComponentPresentations(PublicationId=1,ComponentId=123,TemplateId=1234)/Pages"
      }
    }
  }
 

Since:

0.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static play.libs.F.Function2<org.talares.api.Talares,org.talares.api.datatypes.items.ComponentPresentation,ComponentPresentation>	FROM_SCALA

Constructor Summary

Constructors

Constructor and Description
ComponentPresentation(org.talares.api.Talares api, org.talares.api.datatypes.items.ComponentPresentation scalaComponentPresentation)

Method Summary

Methods

Modifier and Type	Method and Description
Component	getComponent_() BLOCKING
Component	getComponent_(long timeout) BLOCKING
play.libs.F.Promise<Component>	getComponent()
int	getComponentId()
java.lang.String	getOutputFormat()
java.util.List<Page>	getPages_() BLOCKING
java.util.List<Page>	getPages_(long timeout) BLOCKING
play.libs.F.Promise<java.util.List<Page>>	getPages()
java.lang.String	getPresentationContent()
Template	getTemplate_() BLOCKING
Template	getTemplate_(long timeout) BLOCKING
play.libs.F.Promise<Template>	getTemplate()
int	getTemplateId()

Methods inherited from class org.talares.datatypes.items.Item

asJava, getApi, getMetadata, getPublicationId

Methods inherited from class java.lang.Object

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

Field Detail

FROM_SCALA

public static final play.libs.F.Function2<org.talares.api.Talares,org.talares.api.datatypes.items.ComponentPresentation,ComponentPresentation> FROM_SCALA

Constructor Detail

ComponentPresentation

public ComponentPresentation(org.talares.api.Talares api,
                     org.talares.api.datatypes.items.ComponentPresentation scalaComponentPresentation)

Method Detail

getComponentId

public final int getComponentId()

getTemplateId

public final int getTemplateId()

getOutputFormat

public final java.lang.String getOutputFormat()

getPresentationContent

public final java.lang.String getPresentationContent()

getComponent

public final play.libs.F.Promise<Component> getComponent()

getComponent_

public final Component getComponent_(long timeout)
                              throws org.talares.api.exceptions.TalaresException

BLOCKING

Parameters:

timeout - the timeout in which the result should be present

Returns:

a Component

Throws:

org.talares.api.exceptions.TalaresException

getComponent_

public final Component getComponent_()
                              throws org.talares.api.exceptions.TalaresException

BLOCKING

Returns:

a Component

Throws:

org.talares.api.exceptions.TalaresException

getTemplate

public final play.libs.F.Promise<Template> getTemplate()

getTemplate_

public final Template getTemplate_(long timeout)
                            throws org.talares.api.exceptions.TalaresException

BLOCKING

Parameters:

timeout - the timeout in which the result should be present

Returns:

a Template

Throws:

org.talares.api.exceptions.TalaresException

getTemplate_

public final Template getTemplate_()
                            throws org.talares.api.exceptions.TalaresException

BLOCKING

Returns:

a Template

Throws:

org.talares.api.exceptions.TalaresException

getPages

public final play.libs.F.Promise<java.util.List<Page>> getPages()

getPages_

public final java.util.List<Page> getPages_(long timeout)
                                     throws org.talares.api.exceptions.TalaresException

BLOCKING

Parameters:

timeout - the timeout in which the result should be present

Returns:

a List of Page's

Throws:

org.talares.api.exceptions.TalaresException

getPages_

public final java.util.List<Page> getPages_()
                                     throws org.talares.api.exceptions.TalaresException

BLOCKING

Returns:

a List of Page's

Throws:

org.talares.api.exceptions.TalaresException