Package com.microstrategy.web.app.tasks

Class EditObjectTagTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.app.tasks.AbstractAppTask

com.microstrategy.web.app.tasks.EditObjectTagTask

All Implemented Interfaces:

Task

public class EditObjectTagTask
extends AbstractAppTask

This Task can be used to add or remove object tags from a report/document. It creates links or removes links between objects

Field Summary

Fields

Modifier and Type	Field	Description
protected TaskParameterMetadata	addTagListTaskParam
static java.lang.String	OBJECT_TAGS_FOLDER_ID
protected TaskParameterMetadata	objectIDTaskParam
protected TaskParameterMetadata	objectTypeTaskParam
protected static java.lang.String	PARAM_NAME_OBJECT_ID
protected static java.lang.String	PARAM_NAME_OBJECT_TYPE
protected static java.lang.String	PARAM_TAG_ADD_NAME_LIST
protected static java.lang.String	PARAM_TAG_REMOVE_NAME_LIST
protected TaskParameterMetadata	removeTagListTaskParam
static java.lang.String	WEB_LINKS_ID

Fields inherited from class com.microstrategy.web.tasks.AbstractBaseTask

compressOutput, CONTENT_TYPE_BINARY, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, CONTENT_TYPE_JSON_ALL, CONTENT_TYPE_JSON_D, CONTENT_TYPE_JSON_P, CONTENT_TYPE_XML, CONTENT_TYPE_XML_ANF, DEFAULT_MAX_WAIT, DEFAULT_POLLING_FREQ, execFlagsParam, INDEFINITE_MAX_WAIT, maxWaitParam, metadata, mPrivileges, msgIDParam, objectIDParam, OTHER_CONTENT_KEY_LAYOUTS, PARAM_NAME_EXEC_FLAGS, PARAM_NAME_MAX_WAIT, PARAM_NAME_MESSAGE_ID, PARAM_NAME_POLLING_FREQ, PARAM_NAME_RESULT_FLAGS, PARAM_NAME_SESSION_ID, PARAM_NAME_SESSION_STATE, PARAM_NAME_STATE_ID, pollingFreqParam, PREFERENCE_DEFAULT_MAX_WAIT_IN_TASK, resultFlagsParam, sessionIDParam, sessionStateParam, stateIDParam

Constructor Summary

Constructors

Constructor	Description
EditObjectTagTask()

Method Summary

Modifier and Type	Method	Description
static WebObjectInfo	addTag(WebObjectsFactory factory, WebObjectSource wos, java.util.StringTokenizer tag, WebDisplayUnits folderObjects)
static java.lang.String	findTagObjectID(WebDisplayUnits folderObjects, java.lang.String tagName)
static WebDisplayUnits	getObjectTags(WebIServerSession webIServerSession)
void	processRequest(TaskRequestContext context, MarkupOutput markupOutput)	The default implementation of this version of processRequest is empty.

Methods inherited from class com.microstrategy.web.app.tasks.AbstractAppTask

getDescriptor, newRequestContext

Methods inherited from class com.microstrategy.web.tasks.AbstractBaseTask

addExecFlagsParam, addJuilLayouts, addMaxWaitParam, addMaxWaitParam, addMessageIDParam, addObjectIDParam, addParameterMetadata, addParameterMetadata, addParameterMetadata, addPollingFrequencyParam, addPollingFrequencyParam, addResultFlagsParam, addSessionIDParam, addSessionStateParam, addStateIDParam, checkForRequiredParameters, destroy, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, init, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType

Methods inherited from class java.lang.Object

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

Field Detail

WEB_LINKS_ID

public static final java.lang.String WEB_LINKS_ID

See Also:

Constant Field Values

OBJECT_TAGS_FOLDER_ID

public static final java.lang.String OBJECT_TAGS_FOLDER_ID

See Also:

Constant Field Values

PARAM_NAME_OBJECT_ID

protected static final java.lang.String PARAM_NAME_OBJECT_ID

See Also:

Constant Field Values

PARAM_NAME_OBJECT_TYPE

protected static final java.lang.String PARAM_NAME_OBJECT_TYPE

See Also:

Constant Field Values

PARAM_TAG_ADD_NAME_LIST

protected static final java.lang.String PARAM_TAG_ADD_NAME_LIST

See Also:

Constant Field Values

PARAM_TAG_REMOVE_NAME_LIST

protected static final java.lang.String PARAM_TAG_REMOVE_NAME_LIST

See Also:

Constant Field Values

objectIDTaskParam

protected TaskParameterMetadata objectIDTaskParam

objectTypeTaskParam

protected TaskParameterMetadata objectTypeTaskParam

addTagListTaskParam

protected TaskParameterMetadata addTagListTaskParam

removeTagListTaskParam

protected TaskParameterMetadata removeTagListTaskParam

Constructor Detail

EditObjectTagTask

public EditObjectTagTask()

Method Detail

processRequest

public void processRequest(TaskRequestContext context,
                           MarkupOutput markupOutput)
                    throws TaskException

Description copied from class: AbstractBaseTask

The default implementation of this version of processRequest is empty. Task implementators may override either version of processRequest.

Specified by:

processRequest in interface Task

Overrides:

processRequest in class AbstractBaseTask

Parameters:

context - The TaskRequestContext object that maintains the state of the request.

markupOutput - The MarkupOutput that records the contents of the Task response.

Throws:

TaskException - If the Task was unable to satisfy the request.

See Also:

Task.processRequest(TaskRequestContext, MarkupOutput)

addTag

public static WebObjectInfo addTag(WebObjectsFactory factory,
                                   WebObjectSource wos,
                                   java.util.StringTokenizer tag,
                                   WebDisplayUnits folderObjects)
                            throws TaskException

Throws:

TaskException

findTagObjectID

public static java.lang.String findTagObjectID(WebDisplayUnits folderObjects,
                                               java.lang.String tagName)

getObjectTags

public static WebDisplayUnits getObjectTags(WebIServerSession webIServerSession)