Package lumis.content.control.tag

Class InputTagControlResource

java.lang.Object

lumis.content.control.tag.InputTagControlResource

@Path("/lumis/content/control/tag/rest")
public final class InputTagControlResource
extends Object

Content core related operations.

Since:

9.0.0

Version:

$Revision: 19135 $ $Date: 2016-06-02 18:12:21 -0300 (Thu, 02 Jun 2016) $

Constructor Summary

Constructors

Constructor	Description
InputTagControlResource()

Method Summary

Modifier and Type	Method	Description
Response	findTags(String tagName, String tagServiceInstanceId, String relatedServiceInstanceId, int maxResults)	Finds the tags based on the optional term and a service instance. Either tagServiceInstanceId or relatedServiceInstanceId is required.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputTagControlResource

public InputTagControlResource()

Method Detail

findTags

@Path("/find")
@GET
@Produces("application/json")
public Response findTags(@QueryParam("term")
                         String tagName,
                         @QueryParam("tagSII")
                         String tagServiceInstanceId,
                         @QueryParam("relSII")
                         String relatedServiceInstanceId,
                         @QueryParam("maxResults") @DefaultValue("5") @Max(10L) @Min(1L)
                         int maxResults)

Finds the tags based on the optional term and a service instance.
Either tagServiceInstanceId or relatedServiceInstanceId is required. But they cannot be both non-null.
If relatedServiceInstanceId is provided, the tag service instance will be calculated by the tagServiceInstanceId dependency.

Returns one of:

• A JSON string with the matched tags.
• Not found if service instance with the identifier relatedServiceInstanceId has no tag service instance dependency.
• Forbidden if the user has no access to the tag service.
• Internal server error if some error occurred when searching the tags.

Parameters:

tagName - the tag name being searched.

tagServiceInstanceId - the tag service instance identifier.

relatedServiceInstanceId - the related service instance identifier.

maxResults - the maximum results.

Returns:

the accordingly response.

Since:

9.0.0