org.sakaiproject.entitybroker.mocks

Class TaggableEntityProviderMock

java.lang.Object

org.sakaiproject.entitybroker.mocks.EntityProviderMock

org.sakaiproject.entitybroker.mocks.TaggableEntityProviderMock

All Implemented Interfaces:

org.sakaiproject.entitybroker.entityprovider.capabilities.Taggable, org.sakaiproject.entitybroker.entityprovider.capabilities.TagProvideable, org.sakaiproject.entitybroker.entityprovider.EntityProvider, org.sakaiproject.entitybroker.entityprovider.extension.TagProvider

public class TaggableEntityProviderMock
extends EntityProviderMock
implements org.sakaiproject.entitybroker.entityprovider.capabilities.Taggable, org.sakaiproject.entitybroker.entityprovider.capabilities.TagProvideable

Mock which emulates the taggable abilities, note that by default there are no tags on entities

Author:

Aaron Zeckoski (aaron@caret.cam.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Set<String>>	entityTags

Fields inherited from class org.sakaiproject.entitybroker.mocks.EntityProviderMock

prefix

Constructor Summary

Constructors

Constructor and Description
TaggableEntityProviderMock(String prefix) TEST constructor: allows for easy testing
TaggableEntityProviderMock(String prefix, String reference, String[] tags) TEST constructor: allows for easy testing by setting up tags for a specific reference

Method Summary

Methods

Modifier and Type	Method and Description
void	addTagsToEntity(String reference, String[] tags)
List<org.sakaiproject.entitybroker.entityprovider.extension.EntityData>	findEntitesByTags(String[] tags, boolean matchAll, org.sakaiproject.entitybroker.entityprovider.search.Search search)
List<String>	getTagsForEntity(String reference)
void	removeTagsFromEntity(String reference, String[] tags)
void	setTagsForEntity(String reference, String[] tags)

Methods inherited from class org.sakaiproject.entitybroker.mocks.EntityProviderMock

getEntityPrefix

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

getEntityPrefix

Field Detail

entityTags

public Map<String,Set<String>> entityTags

Constructor Detail

TaggableEntityProviderMock

public TaggableEntityProviderMock(String prefix)

TEST constructor: allows for easy testing

Parameters:

prefix -

TaggableEntityProviderMock

public TaggableEntityProviderMock(String prefix,
                          String reference,
                          String[] tags)

TEST constructor: allows for easy testing by setting up tags for a specific reference

Parameters:

prefix -

reference - an entity reference

tags - an array of tags for this reference

Method Detail

addTagsToEntity

public void addTagsToEntity(String reference,
                   String[] tags)

Specified by:

addTagsToEntity in interface org.sakaiproject.entitybroker.entityprovider.extension.TagProvider

getTagsForEntity

public List<String> getTagsForEntity(String reference)

Specified by:

getTagsForEntity in interface org.sakaiproject.entitybroker.entityprovider.extension.TagProvider

removeTagsFromEntity

public void removeTagsFromEntity(String reference,
                        String[] tags)

Specified by:

removeTagsFromEntity in interface org.sakaiproject.entitybroker.entityprovider.extension.TagProvider

setTagsForEntity

public void setTagsForEntity(String reference,
                    String[] tags)

Specified by:

setTagsForEntity in interface org.sakaiproject.entitybroker.entityprovider.extension.TagProvider

findEntitesByTags

public List<org.sakaiproject.entitybroker.entityprovider.extension.EntityData> findEntitesByTags(String[] tags,
                                                                                        boolean matchAll,
                                                                                        org.sakaiproject.entitybroker.entityprovider.search.Search search)

Specified by:

findEntitesByTags in interface org.sakaiproject.entitybroker.entityprovider.capabilities.TagProvideable