org.alfresco.rest.api.sites

Class SiteEntityResource

java.lang.Object

org.alfresco.rest.api.sites.SiteEntityResource

All Implemented Interfaces:

EntityResourceAction.Read<Site>, EntityResourceAction.ReadById<Site>, ResourceAction, org.springframework.beans.factory.InitializingBean

@EntityResource(name="sites",
                title="Sites")
public class SiteEntityResource
extends Object
implements EntityResourceAction.Read<Site>, EntityResourceAction.ReadById<Site>, org.springframework.beans.factory.InitializingBean

An implementation of an Entity Resource for a Site

Author:

Gethin James, steveglover

Constructor Summary

Constructors

Constructor and Description
SiteEntityResource()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
CollectionWithPagingInfo<Site>	readAll(Parameters parameters) Returns a paged list of all sites in the current tenant.
Site	readById(String siteId, Parameters parameters) Returns information regarding the 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

SiteEntityResource

public SiteEntityResource()

Method Detail

setSites

public void setSites(Sites sites)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

readAll

public CollectionWithPagingInfo<Site> readAll(Parameters parameters)

Returns a paged list of all sites in the current tenant.

Specified by:

readAll in interface EntityResourceAction.Read<Site>

Parameters:

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

Returns:

See Also:

org.alfresco.rest.framework.resource.actions.interfaces.CollectionResourceAction.Get#get()

readById

public Site readById(String siteId,
            Parameters parameters)

Returns information regarding the site 'siteId'.

Specified by:

readById in interface EntityResourceAction.ReadById<Site>