org.alfresco.rest.api.people

Class PersonFavouriteSitesRelation

java.lang.Object

org.alfresco.rest.api.people.PersonFavouriteSitesRelation

All Implemented Interfaces:

RelationshipResourceAction.Create<FavouriteSite>, RelationshipResourceAction.Delete, RelationshipResourceAction.Read<FavouriteSite>, RelationshipResourceAction.ReadById<FavouriteSite>, ResourceAction, org.springframework.beans.factory.InitializingBean

@RelationshipResource(name="favorite-sites",
                      entityResource=PeopleEntityResource.class,
                      title="Person Favorite Sites")
public class PersonFavouriteSitesRelation
extends Object
implements RelationshipResourceAction.Read<FavouriteSite>, RelationshipResourceAction.ReadById<FavouriteSite>, RelationshipResourceAction.Create<FavouriteSite>, RelationshipResourceAction.Delete, org.springframework.beans.factory.InitializingBean

Author:

steveglover

Constructor Summary

Constructors

Constructor and Description
PersonFavouriteSitesRelation()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
List<FavouriteSite>	create(String personId, List<FavouriteSite> entity, Parameters parameters) Adds the given site as a favourite site for the user.
void	delete(String personId, String siteId, Parameters parameters)
CollectionWithPagingInfo<FavouriteSite>	readAll(String personId, Parameters parameters) List the user's favourite sites.
FavouriteSite	readById(String personId, String siteShortName, Parameters parameters) List the favourite site information for a specific site.
void	setSites(Sites sites)

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonFavouriteSitesRelation

public PersonFavouriteSitesRelation()

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<FavouriteSite> readAll(String personId,
                                                       Parameters parameters)

List the user's favourite sites.

Specified by:

readAll in interface RelationshipResourceAction.Read<FavouriteSite>

Parameters:

personId - Entity resource context for this relationship

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

See Also:

RelationshipResourceAction.Read.readAll(java.lang.String, org.alfresco.rest.framework.resource.parameters.Parameters)

readById

public FavouriteSite readById(String personId,
                              String siteShortName,
                              Parameters parameters)

List the favourite site information for a specific site.

Specified by:

readById in interface RelationshipResourceAction.ReadById<FavouriteSite>

See Also:

RelationshipResourceAction.ReadById.readById(String, String, org.alfresco.rest.framework.resource.parameters.Parameters)

create

public List<FavouriteSite> create(String personId,
                                  List<FavouriteSite> entity,
                                  Parameters parameters)

Adds the given site as a favourite site for the user.

Specified by:

create in interface RelationshipResourceAction.Create<FavouriteSite>

See Also:

RelationshipResourceAction.Create.create(String, java.util.List, org.alfresco.rest.framework.resource.parameters.Parameters)

delete

public void delete(String personId,
                   String siteId,
                   Parameters parameters)

Specified by:

delete in interface RelationshipResourceAction.Delete