Package org.alfresco.rest.core

Class RestModels<Model,ModelCollection>

java.lang.Object

org.alfresco.rest.core.RestModels<Model,ModelCollection>

All Implemented Interfaces:

IModelsCollectionAssertion<ModelCollection>, IRestModelsCollection<Model>

Direct Known Subclasses:

RestActionDefinitionModelsCollection, RestActivityModelsCollection, RestAuditAppModelsCollection, RestAuditEntryModelsCollection, RestCandidateModelsCollection, RestCommentModelsCollection, RestDeploymentModelsCollection, RestFormModelsCollection, RestGroupMemberModelsCollection, RestGroupsModelsCollection, RestItemModelsCollection, RestNetworkModelsCollection, RestNodeAssociationModelCollection, RestNodeChildAssocModelCollection, RestNodeModelsCollection, RestPersonFavoritesModelsCollection, RestPersonModelsCollection, RestPreferenceModelsCollection, RestProcessDefinitionModelsCollection, RestProcessModelsCollection, RestProcessVariableCollection, RestRatingModelsCollection, RestRenditionInfoModelCollection, RestShardInfoModelCollection, RestSharedLinksModelCollection, RestSiteContainerModelsCollection, RestSiteMemberModelsCollection, RestSiteMembershipModelsCollection, RestSiteMembershipRequestModelsCollection, RestSiteModelsCollection, RestSitePersonMembershipRequestModelsCollection, RestSubscriberModelCollection, RestSyncNodeSubscriptionModelCollection, RestTagModelsCollection, RestTaskModelsCollection, RestVariableModelsCollection, RestVersionModelsCollection, SearchNodeModelsCollection, SearchResponse

public abstract class RestModels<Model,ModelCollection>
extends java.lang.Object
implements IRestModelsCollection<Model>, IModelsCollectionAssertion<ModelCollection>

Map multiple entries of JSON response to a class Example: "entries": [ { "entry": { "visibility": "PUBLIC", "guid": "79e140e1-5039-4efa-acaf-c22b5ba7c947", "description": "Description1470255221170", "id": "0-C2291-1470255221170", "title": "0-C2291-1470255221170" } }, Having this JSON Entry, we can auto-map this to RestSiteModelsCollection class having a List of based on this example

Author:

Paul Brodner

Constructor Summary

Constructors

Constructor	Description
RestModels()

Method Summary

Modifier and Type	Method	Description
ModelsCollectionAssertion<RestModels<Model,ModelCollection>>	and()
ModelsCollectionAssertion<RestModels<Model,ModelCollection>>	assertThat()
java.util.List<Model>	getEntries()
Model	getEntryByIndex(int index)	Example siteMembershipRequests.getEntryByIndex(0) .assertThat().field("site.visibility").is(moderatedSite.getVisibility()) .assertThat().field("site.description").is(moderatedSite.getDescription()) .assertThat().field("site.id").is(moderatedSite.getId()) .assertThat().field("site.title").is(moderatedSite.getTitle());
Model	getOneRandomEntry()
RestPaginationModel	getPagination()
boolean	isEmpty()
void	setPagination(RestPaginationModel pagination)
ModelCollection	when()

Methods inherited from class java.lang.Object

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

Constructor Detail

RestModels

public RestModels()

Method Detail

getEntries

public java.util.List<Model> getEntries()

Specified by:

getEntries in interface IRestModelsCollection<Model>

getOneRandomEntry

public Model getOneRandomEntry()
                        throws EmptyRestModelCollectionException

Specified by:

getOneRandomEntry in interface IRestModelsCollection<Model>

Returns:

a random entry from entries list

Throws:

EmptyRestModelCollectionException

getEntryByIndex

public Model getEntryByIndex(int index)
                      throws EmptyRestModelCollectionException

Example siteMembershipRequests.getEntryByIndex(0) .assertThat().field("site.visibility").is(moderatedSite.getVisibility()) .assertThat().field("site.description").is(moderatedSite.getDescription()) .assertThat().field("site.id").is(moderatedSite.getId()) .assertThat().field("site.title").is(moderatedSite.getTitle());

Parameters:

index -

Returns:

Throws:

EmptyRestModelCollectionException

assertThat

public ModelsCollectionAssertion<RestModels<Model,ModelCollection>> assertThat()

Specified by:

assertThat in interface IModelsCollectionAssertion<Model>

and

public ModelsCollectionAssertion<RestModels<Model,ModelCollection>> and()

Specified by:

and in interface IModelsCollectionAssertion<Model>

when

public ModelCollection when()

Specified by:

when in interface IModelsCollectionAssertion<Model>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IRestModelsCollection<Model>

Returns:

boolean value if entry is empty

getPagination

public RestPaginationModel getPagination()

Specified by:

getPagination in interface IRestModelsCollection<Model>

setPagination

public void setPagination(RestPaginationModel pagination)