org.alfresco.rest.api.people

Class PersonFavouritesRelation

java.lang.Object

org.alfresco.rest.api.people.PersonFavouritesRelation

All Implemented Interfaces:

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

@RelationshipResource(name="favorites",
                      entityResource=PeopleEntityResource.class,
                      title="Person Favorites")
public class PersonFavouritesRelation
extends Object
implements RelationshipResourceAction.Read<Favourite>, RelationshipResourceAction.ReadById<Favourite>, RelationshipResourceAction.Create<Favourite>, RelationshipResourceAction.Delete, org.springframework.beans.factory.InitializingBean

Constructor Summary

Constructors

Constructor and Description
PersonFavouritesRelation()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
List<Favourite>	create(String personId, List<Favourite> entity, Parameters parameters) Adds the given site as a favourite site for the user.
void	delete(String personId, String id, Parameters parameters)
CollectionWithPagingInfo<Favourite>	readAll(String personId, Parameters parameters) List the user's favourites.
Favourite	readById(String personId, String favouriteId, Parameters parameters)
void	setFavourites(Favourites favourites)

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonFavouritesRelation

public PersonFavouritesRelation()

Method Detail

setFavourites

public void setFavourites(Favourites favourites)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

readAll

public CollectionWithPagingInfo<Favourite> readAll(String personId,
                                                   Parameters parameters)

List the user's favourites.

Specified by:

readAll in interface RelationshipResourceAction.Read<Favourite>

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)

create

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

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

Specified by:

create in interface RelationshipResourceAction.Create<Favourite>

See Also:

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

delete

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

Specified by:

delete in interface RelationshipResourceAction.Delete

readById

public Favourite readById(String personId,
                          String favouriteId,
                          Parameters parameters)
                   throws RelationshipResourceNotFoundException

Specified by:

readById in interface RelationshipResourceAction.ReadById<Favourite>

Throws:

RelationshipResourceNotFoundException