org.talares.datatypes.items

Class StructureGroup

java.lang.Object

org.talares.datatypes.items.Item

org.talares.datatypes.items.StructureGroup

public class StructureGroup
extends Item

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

  {
    "__metadata": {
      "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/StructureGroups(PublicationId=1,Id=2)",
      "type": "Tridion.ContentDelivery.StructureGroup"
    },
    "Depth": 0,
    "Directory": null,
    "Id": 123,
    "PublicationId": 1,
    "Title": "A title",
    "Pages": {
      "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/StructureGroups(Id=2,PublicationId=1)/Pages"
      }
    },
    "Children": {
      "__deferred": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/StructureGroups(Id=2,PublicationId=1)/Children"
      }
    },
    "Parent": {
      "__deferred": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/StructureGroups(Id=2,PublicationId=1)/Parent"
      }
    }
  }
 

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.StructureGroup,StructureGroup>	FROM_SCALA

Constructor Summary

Constructors

Constructor and Description
StructureGroup(org.talares.api.Talares api, org.talares.api.datatypes.items.StructureGroup scalaStructureGroup)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<StructureGroup>	getChildren_() BLOCKING
java.util.List<StructureGroup>	getChildren_(long timeout) BLOCKING
play.libs.F.Promise<java.util.List<StructureGroup>>	getChildren()
int	getDepth()
java.lang.String	getDirectory()
int	getId()
java.util.List<Page>	getPages_() BLOCKING
java.util.List<Page>	getPages_(long timeout) BLOCKING
play.libs.F.Promise<java.util.List<Page>>	getPages()
StructureGroup	getParent_() BLOCKING
StructureGroup	getParent_(long timeout) BLOCKING
play.libs.F.Promise<StructureGroup>	getParent()
java.lang.String	getTitle()

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.StructureGroup,StructureGroup> FROM_SCALA

Constructor Detail

StructureGroup

public StructureGroup(org.talares.api.Talares api,
              org.talares.api.datatypes.items.StructureGroup scalaStructureGroup)

Method Detail

getId

public final int getId()

getTitle

public final java.lang.String getTitle()

getDepth

public final int getDepth()

getDirectory

public final java.lang.String getDirectory()

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

getParent

public final play.libs.F.Promise<StructureGroup> getParent()

getParent_

public final StructureGroup getParent_(long timeout)
                                throws org.talares.api.exceptions.TalaresException

BLOCKING

Parameters:

timeout - the timeout in which the result should be present

Returns:

a StructureGroup

Throws:

org.talares.api.exceptions.TalaresException

getParent_

public final StructureGroup getParent_()
                                throws org.talares.api.exceptions.TalaresException

BLOCKING

Returns:

a StructureGroup

Throws:

org.talares.api.exceptions.TalaresException

getChildren

public final play.libs.F.Promise<java.util.List<StructureGroup>> getChildren()

getChildren_

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

BLOCKING

Parameters:

timeout - the timeout in which the result should be present

Returns:

a List of StructureGroup's

Throws:

org.talares.api.exceptions.TalaresException

getChildren_

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

BLOCKING

Returns:

a List of StructureGroup's

Throws:

org.talares.api.exceptions.TalaresException