Package org.alfresco.repo.tagging.script

Class ScriptTaggingService

java.lang.Object

org.alfresco.repo.processor.BaseProcessorExtension

org.alfresco.repo.jscript.BaseScopableProcessorExtension

org.alfresco.repo.tagging.script.ScriptTaggingService

All Implemented Interfaces:

org.alfresco.processor.ProcessorExtension, Scopeable

public class ScriptTaggingService
extends BaseScopableProcessorExtension

Script object representing the tagging service.

Author:

Roy Wetherall

Constructor Summary

Constructors

Constructor	Description
ScriptTaggingService()

Method Summary

Modifier and Type	Method	Description
ScriptNode	createTag(java.lang.String store, java.lang.String tag)	Create a tag in a given store
void	deleteTag(java.lang.String store, java.lang.String tag)	delete tag at the given store
PagedTagsWrapper	getPagedTags(java.lang.String store, int fromTag, int pageSize)	Get page of tags with totalRecords info
PagedTagsWrapper	getPagedTags(java.lang.String store, java.lang.String filter, int fromTag, int pageSize)
ScriptNode	getTag(java.lang.String store, java.lang.String tag)	Get a tag by name if available in a store
java.lang.String[]	getTags(java.lang.String store)	Get all the tags available in a store
java.lang.String[]	getTags(java.lang.String store, java.lang.String filter)	Get all the tags available in a store based on a text filter
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the Service Registry

Methods inherited from class org.alfresco.repo.jscript.BaseScopableProcessorExtension

getScope, setScope

Methods inherited from class org.alfresco.repo.processor.BaseProcessorExtension

getExtensionName, register, setExtensionName, setProcessor

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptTaggingService

public ScriptTaggingService()

Method Detail

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Sets the Service Registry

Parameters:

serviceRegistry - ServiceRegistry

getTags

public java.lang.String[] getTags(java.lang.String store)

Get all the tags available in a store

Parameters:

store - store reference

Returns:

String[] tag names

getPagedTags

public PagedTagsWrapper getPagedTags(java.lang.String store,
                                     int fromTag,
                                     int pageSize)

Get page of tags with totalRecords info

Parameters:

store - String

fromTag - int

pageSize - int

Returns:

PagedTagsWrapper

getTags

public java.lang.String[] getTags(java.lang.String store,
                                  java.lang.String filter)

Get all the tags available in a store based on a text filter

Parameters:

store - store reference

filter - tag filter

Returns:

String[] tag names

getPagedTags

public PagedTagsWrapper getPagedTags(java.lang.String store,
                                     java.lang.String filter,
                                     int fromTag,
                                     int pageSize)

getTag

public ScriptNode getTag(java.lang.String store,
                         java.lang.String tag)

Get a tag by name if available in a store

Parameters:

store - store reference

tag - tag name

Returns:

ScriptNode tag node, or null if not found

createTag

public ScriptNode createTag(java.lang.String store,
                            java.lang.String tag)

Create a tag in a given store

Parameters:

store - store reference

tag - tag name

Returns:

ScriptNode newly created tag node, or null if unable to create

deleteTag

public void deleteTag(java.lang.String store,
                      java.lang.String tag)

delete tag at the given store

Parameters:

store - store reference

tag - tag name