com.equilibrium.services

Class CollectionService

java.lang.Object

com.equilibrium.services.HttpService

com.equilibrium.services.HttpXmlService

com.equilibrium.services.HttpEntityService<Collection>

com.equilibrium.services.CollectionService

public class CollectionService
extends HttpEntityService<Collection>

Collections (or channels) are essentially folders that ContentFiles can be stored in. They are currently *not* nested. The following are the major Collection functions.

Since:

9/25/13

Author:

James Hays

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectionService.SocialAction
static class	CollectionService.SocialService

Constructor Summary

Constructors

Constructor and Description
CollectionService(UUID sessionGuid)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addSocialEvent(Collection collection, CollectionService.SocialAction socialAction, CollectionService.SocialService excludeSocialService, Boolean force)
EQAsyncTask<Boolean>	addSocialEvent(Collection collection, CollectionService.SocialAction socialAction, CollectionService.SocialService excludeSocialService, Boolean force, ResponseDelegate<Boolean> responseDelegate)
boolean	addUserRelationshipToCollection(Collection collection, Collection.UserCollectionType userCollectionType)
boolean	addUserRelationshipToCollection(Collection collection, Collection.UserCollectionType userCollectionType, Integer collectionTriggerId, Boolean silent)
EQAsyncTask<Boolean>	addUserRelationshipToCollection(Collection collection, Collection.UserCollectionType userCollectionType, Integer collectionTriggerId, Boolean silent, ResponseDelegate<Boolean> responseDelegate)
EQAsyncTask<Boolean>	addUserRelationshipToCollection(Collection collection, Collection.UserCollectionType userCollectionType, ResponseDelegate<Boolean> responseDelegate)
Collection	createCollection(Collection collection)
Collection	createCollection(Collection collection, File icon)
EQAsyncTask<Collection>	createCollection(Collection collection, File icon, ResponseDelegate<Collection> responseDelegate)
Collection	createCollection(Collection collection, InputStream icon, String fileName)
EQAsyncTask<Collection>	createCollection(Collection collection, InputStream icon, String fileName, ResponseDelegate<Collection> responseDelegate)
EQAsyncTask<Collection>	createCollection(Collection collection, ResponseDelegate<Collection> responseDelegate)
boolean	deleteCollection(Collection collection)
EQAsyncTask<Boolean>	deleteCollection(Collection collection, ResponseDelegate<Boolean> responseDelegate)
boolean	deleteCollection(Integer collectionId)
EQAsyncTask<Boolean>	deleteCollection(Integer collectionId, ResponseDelegate<Boolean> responseDelegate)
Collection	getCollection(int collectionId)
EQAsyncTask<Collection>	getCollection(int collectionId, ResponseDelegate<Collection> responseDelegate)
Collection	getCollection(UUID collectionGuid)
EQAsyncTask<Collection>	getCollection(UUID collectionGuid, ResponseDelegate<Collection> responseDelegate)
Collection	getCollectionRequest(UUID collectionRequestGuid)
EQAsyncTask<Collection>	getCollectionRequest(UUID collectionRequestGuid, ResponseDelegate<Collection> responseDelegate)
List<Collection>	getCollections()
List<Collection>	getCollections(CollectionContext collectionContext, PagingParameters pagingParameters)
EQAsyncTask<List<Collection>>	getCollections(CollectionContext collectionContext, PagingParameters pagingParameters, ResponseDelegate<List<Collection>> responseDelegate)
EQAsyncTask<List<Collection>>	getCollections(ResponseDelegate<List<Collection>> responseDelegate)
List<Collection>	getCollections(User user, CollectionContext collectionContext, PagingParameters pagingParameters)
EQAsyncTask<List<Collection>>	getCollections(User user, CollectionContext collectionContext, PagingParameters pagingParameters, ResponseDelegate<List<Collection>> responseDelegate)
List<ContentFile>	listFavoritedContentFiles(User user, ContentFileContext contentFileContext, PagingParameters pagingParameters)
EQAsyncTask<List<ContentFile>>	listFavoritedContentFiles(User user, ContentFileContext contentFileContext, PagingParameters pagingParameters, ResponseDelegate<List<ContentFile>> responseDelegate)
boolean	markAsViewed(Collection collection)
EQAsyncTask<Boolean>	markAsViewed(Collection collection, ResponseDelegate<Boolean> responseDelegate)
boolean	removeSocialEvent(Collection collection, CollectionService.SocialAction socialAction, Boolean force)
EQAsyncTask<Boolean>	removeSocialEvent(Collection collection, CollectionService.SocialAction socialAction, Boolean force, ResponseDelegate<Boolean> responseDelegate)
boolean	updateCollection(Collection collection, boolean deleteIcon)
EQAsyncTask<Boolean>	updateCollection(Collection collection, boolean deleteIcon, ResponseDelegate<Boolean> responseDelegate)
boolean	updateCollection(Collection collection, File icon)
EQAsyncTask<Boolean>	updateCollection(Collection collection, File icon, ResponseDelegate<Boolean> responseDelegate)
boolean	updateCollection(Collection collection, InputStream icon, String fileName)
EQAsyncTask<Boolean>	updateCollection(Collection collection, InputStream icon, String fileName, ResponseDelegate<Boolean> responseDelegate)

Methods inherited from class com.equilibrium.services.HttpEntityService

getSessionGuid, setSessionGuid

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionService

public CollectionService(UUID sessionGuid)

Method Detail

getCollection

public EQAsyncTask<Collection> getCollection(int collectionId,
                                    ResponseDelegate<Collection> responseDelegate)

getCollection

public Collection getCollection(int collectionId)
                         throws EQServiceException,
                                EQEntityException

Throws:

EQServiceException

EQEntityException

getCollection

public EQAsyncTask<Collection> getCollection(UUID collectionGuid,
                                    ResponseDelegate<Collection> responseDelegate)

getCollection

public Collection getCollection(UUID collectionGuid)
                         throws EQServiceException,
                                EQEntityException

Throws:

EQServiceException

EQEntityException

getCollectionRequest

public EQAsyncTask<Collection> getCollectionRequest(UUID collectionRequestGuid,
                                           ResponseDelegate<Collection> responseDelegate)

getCollectionRequest

public Collection getCollectionRequest(UUID collectionRequestGuid)
                                throws EQServiceException,
                                       EQEntityException

Throws:

EQServiceException

EQEntityException

getCollections

public EQAsyncTask<List<Collection>> getCollections(ResponseDelegate<List<Collection>> responseDelegate)

getCollections

public List<Collection> getCollections()
                                throws EQServiceException,
                                       EQEntityException

Throws:

EQServiceException

EQEntityException

getCollections

public EQAsyncTask<List<Collection>> getCollections(CollectionContext collectionContext,
                                           PagingParameters pagingParameters,
                                           ResponseDelegate<List<Collection>> responseDelegate)

getCollections

public List<Collection> getCollections(CollectionContext collectionContext,
                              PagingParameters pagingParameters)
                                throws EQServiceException,
                                       EQEntityException

Throws:

EQServiceException

EQEntityException

getCollections

public EQAsyncTask<List<Collection>> getCollections(User user,
                                           CollectionContext collectionContext,
                                           PagingParameters pagingParameters,
                                           ResponseDelegate<List<Collection>> responseDelegate)

getCollections

public List<Collection> getCollections(User user,
                              CollectionContext collectionContext,
                              PagingParameters pagingParameters)
                                throws EQServiceException,
                                       EQEntityException

Throws:

EQServiceException

EQEntityException

createCollection

public EQAsyncTask<Collection> createCollection(Collection collection,
                                       ResponseDelegate<Collection> responseDelegate)

createCollection

public Collection createCollection(Collection collection)
                            throws EQServiceException,
                                   EQEntityException

Throws:

EQServiceException

EQEntityException

createCollection

public EQAsyncTask<Collection> createCollection(Collection collection,
                                       File icon,
                                       ResponseDelegate<Collection> responseDelegate)

createCollection

public Collection createCollection(Collection collection,
                          File icon)
                            throws EQServiceException,
                                   EQEntityException

Throws:

EQServiceException

EQEntityException

createCollection

public EQAsyncTask<Collection> createCollection(Collection collection,
                                       InputStream icon,
                                       String fileName,
                                       ResponseDelegate<Collection> responseDelegate)

createCollection

public Collection createCollection(Collection collection,
                          InputStream icon,
                          String fileName)
                            throws EQServiceException,
                                   EQEntityException

Throws:

EQServiceException

EQEntityException

updateCollection

public EQAsyncTask<Boolean> updateCollection(Collection collection,
                                    boolean deleteIcon,
                                    ResponseDelegate<Boolean> responseDelegate)

updateCollection

public boolean updateCollection(Collection collection,
                       boolean deleteIcon)
                         throws EQServiceException,
                                EQEntityException

Throws:

EQServiceException

EQEntityException

updateCollection

public EQAsyncTask<Boolean> updateCollection(Collection collection,
                                    File icon,
                                    ResponseDelegate<Boolean> responseDelegate)

updateCollection

public boolean updateCollection(Collection collection,
                       File icon)
                         throws EQServiceException,
                                EQEntityException

Throws:

EQServiceException

EQEntityException

updateCollection

public EQAsyncTask<Boolean> updateCollection(Collection collection,
                                    InputStream icon,
                                    String fileName,
                                    ResponseDelegate<Boolean> responseDelegate)

updateCollection

public boolean updateCollection(Collection collection,
                       InputStream icon,
                       String fileName)
                         throws EQServiceException,
                                EQEntityException

Throws:

EQServiceException

EQEntityException

deleteCollection

public EQAsyncTask<Boolean> deleteCollection(Collection collection,
                                    ResponseDelegate<Boolean> responseDelegate)

deleteCollection

public boolean deleteCollection(Collection collection)
                         throws EQServiceException,
                                EQEntityException

Throws:

EQServiceException

EQEntityException

deleteCollection

public EQAsyncTask<Boolean> deleteCollection(Integer collectionId,
                                    ResponseDelegate<Boolean> responseDelegate)

deleteCollection

public boolean deleteCollection(Integer collectionId)
                         throws EQServiceException,
                                EQEntityException

Throws:

EQServiceException

EQEntityException

addUserRelationshipToCollection

public EQAsyncTask<Boolean> addUserRelationshipToCollection(Collection collection,
                                                   Collection.UserCollectionType userCollectionType,
                                                   ResponseDelegate<Boolean> responseDelegate)

addUserRelationshipToCollection

public boolean addUserRelationshipToCollection(Collection collection,
                                      Collection.UserCollectionType userCollectionType)
                                        throws EQServiceException,
                                               EQEntityException

Throws:

EQServiceException

EQEntityException

addUserRelationshipToCollection

public EQAsyncTask<Boolean> addUserRelationshipToCollection(Collection collection,
                                                   Collection.UserCollectionType userCollectionType,
                                                   Integer collectionTriggerId,
                                                   Boolean silent,
                                                   ResponseDelegate<Boolean> responseDelegate)

addUserRelationshipToCollection

public boolean addUserRelationshipToCollection(Collection collection,
                                      Collection.UserCollectionType userCollectionType,
                                      Integer collectionTriggerId,
                                      Boolean silent)
                                        throws EQServiceException,
                                               EQEntityException

Throws:

EQServiceException

EQEntityException

addSocialEvent

public EQAsyncTask<Boolean> addSocialEvent(Collection collection,
                                  CollectionService.SocialAction socialAction,
                                  CollectionService.SocialService excludeSocialService,
                                  Boolean force,
                                  ResponseDelegate<Boolean> responseDelegate)

addSocialEvent

public boolean addSocialEvent(Collection collection,
                     CollectionService.SocialAction socialAction,
                     CollectionService.SocialService excludeSocialService,
                     Boolean force)
                       throws EQServiceException,
                              EQEntityException

Throws:

EQServiceException

EQEntityException

removeSocialEvent

public EQAsyncTask<Boolean> removeSocialEvent(Collection collection,
                                     CollectionService.SocialAction socialAction,
                                     Boolean force,
                                     ResponseDelegate<Boolean> responseDelegate)

removeSocialEvent

public boolean removeSocialEvent(Collection collection,
                        CollectionService.SocialAction socialAction,
                        Boolean force)
                          throws EQServiceException,
                                 EQEntityException

Throws:

EQServiceException

EQEntityException

markAsViewed

public EQAsyncTask<Boolean> markAsViewed(Collection collection,
                                ResponseDelegate<Boolean> responseDelegate)

markAsViewed

public boolean markAsViewed(Collection collection)
                     throws EQServiceException,
                            EQEntityException

Throws:

EQServiceException

EQEntityException

listFavoritedContentFiles

public EQAsyncTask<List<ContentFile>> listFavoritedContentFiles(User user,
                                                       ContentFileContext contentFileContext,
                                                       PagingParameters pagingParameters,
                                                       ResponseDelegate<List<ContentFile>> responseDelegate)

listFavoritedContentFiles

public List<ContentFile> listFavoritedContentFiles(User user,
                                          ContentFileContext contentFileContext,
                                          PagingParameters pagingParameters)
                                            throws EQServiceException,
                                                   EQEntityException

Throws:

EQServiceException

EQEntityException