org.alfresco.rest.api.sites

Class SiteContainersRelation

java.lang.Object

org.alfresco.rest.api.sites.SiteContainersRelation

All Implemented Interfaces:

RelationshipResourceAction.Read<SiteContainer>, RelationshipResourceAction.ReadById<SiteContainer>, ResourceAction, org.springframework.beans.factory.InitializingBean

@RelationshipResource(name="containers",
                      entityResource=SiteEntityResource.class,
                      title="Site Containers")
public class SiteContainersRelation
extends Object
implements RelationshipResourceAction.Read<SiteContainer>, RelationshipResourceAction.ReadById<SiteContainer>, org.springframework.beans.factory.InitializingBean

Constructor Summary

Constructors

Constructor and Description
SiteContainersRelation()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
CollectionWithPagingInfo<SiteContainer>	readAll(String siteId, Parameters parameters) Returns information regarding the top level containers for site 'siteId'.
SiteContainer	readById(String siteId, String containerId, Parameters parameters) Returns information regarding the top level container 'containerId' for site 'siteId'.
void	setSites(Sites sites)

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteContainersRelation

public SiteContainersRelation()

Method Detail

setSites

public void setSites(Sites sites)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

readById

public SiteContainer readById(String siteId,
                              String containerId,
                              Parameters parameters)

Returns information regarding the top level container 'containerId' for site 'siteId'.

Specified by:

readById in interface RelationshipResourceAction.ReadById<SiteContainer>

readAll

public CollectionWithPagingInfo<SiteContainer> readAll(String siteId,
                                                       Parameters parameters)

Returns information regarding the top level containers for site 'siteId'.

Specified by:

readAll in interface RelationshipResourceAction.Read<SiteContainer>

Parameters:

siteId - Entity resource context for this relationship

parameters - - will never be null and will have the PAGING default values