org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.task
Class OpenSearchGenerationTaskType

java.lang.Object
  extended by org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.ExecutionEntity
      extended by org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.task.CustomTaskType
          extended by org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.task.OpenSearchGenerationTaskType
All Implemented Interfaces:
Cloneable, Evaluable

public class OpenSearchGenerationTaskType
extends CustomTaskType


Nested Class Summary
 
Nested classes/interfaces inherited from class org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.ExecutionEntity
ExecutionEntity.ExecutionState
 
Field Summary
 
Fields inherited from class org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.ExecutionEntity
entityName, execState, isGoalFulfilled, parent, scope, UID
 
Constructor Summary
OpenSearchGenerationTaskType()
          Class Constructor
 
Method Summary
 void executeTask(TaskExecutionData execData)
          Executes the task.
 String getUIDescription()
          Returns a string which will be displayed in the user interface as a description for this entity.
 Document getXMLTaskDefinitionDocument()
          Returns a Document object defining the XML structure of this task's contents.
 
Methods inherited from class org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.task.CustomTaskType
cancel, clone, evaluate, execute, getAttributeValue, getInput, getOutput, getTypeName, initialize, initializeWithDataInScope, newInstance, toXML, willRun
 
Methods inherited from class org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.ExecutionEntity
assignRandomUID, createExecutionLog, getExecutionLogger, getExecutionState, getName, getParent, getScope, getUID, isFulfilled, setExecutionState, setIsFulfilled, setParent, setScope
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OpenSearchGenerationTaskType

public OpenSearchGenerationTaskType()
Class Constructor

Method Detail

executeTask

public void executeTask(TaskExecutionData execData)
Description copied from class: CustomTaskType
Executes the task. No exceptions can be thrown by this method. In case of errors or warnings, the task implementation should log an appropriate message to the execution log.

Specified by:
executeTask in class CustomTaskType
Parameters:
execData - a TaskExecutionData object containing useful information that can be used during the task's execution

getXMLTaskDefinitionDocument

public Document getXMLTaskDefinitionDocument()
                                      throws Exception
Description copied from class: CustomTaskType
Returns a Document object defining the XML structure of this task's contents.

Specified by:
getXMLTaskDefinitionDocument in class CustomTaskType
Returns:
the XML task definition document
Throws:
Exception

getUIDescription

public String getUIDescription()
Description copied from class: ExecutionEntity
Returns a string which will be displayed in the user interface as a description for this entity.

Specified by:
getUIDescription in class ExecutionEntity
Returns:
the entity description


Copyright © 2013. All Rights Reserved.