org.alfresco.rest.api.people

Class PersonPreferencesRelation

java.lang.Object

org.alfresco.rest.api.people.PersonPreferencesRelation

All Implemented Interfaces:

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

@RelationshipResource(name="preferences",
                      entityResource=PeopleEntityResource.class,
                      title="Person Preferences")
public class PersonPreferencesRelation
extends Object
implements RelationshipResourceAction.Read<Preference>, RelationshipResourceAction.ReadById<Preference>, org.springframework.beans.factory.InitializingBean

Constructor Summary

Constructors

Constructor and Description
PersonPreferencesRelation()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
CollectionWithPagingInfo<Preference>	readAll(String personId, Parameters parameters) Returns a paged list of preferences for the user personId.
Preference	readById(String personId, String preferenceName, Parameters parameters) Returns information regarding the preference 'preferenceName' for user personId.
void	setPreferences(Preferences preferences)

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonPreferencesRelation

public PersonPreferencesRelation()

Method Detail

setPreferences

public void setPreferences(Preferences preferences)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

readAll

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

Returns a paged list of preferences for the user personId. If personId does not exist, NotFoundException (status 404).

Specified by:

readAll in interface RelationshipResourceAction.Read<Preference>

Parameters:

personId - Entity resource context for this relationship

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

Returns:

See Also:

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

readById

public Preference readById(String personId,
                  String preferenceName,
                  Parameters parameters)

Returns information regarding the preference 'preferenceName' for user personId. If personId does not exist, NotFoundException (status 404).

Specified by:

readById in interface RelationshipResourceAction.ReadById<Preference>

See Also:

org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.ReadById#readById(java.lang.String, java.lang.String)