Package com.inet.repository.taskplanner
Class RepositoryResultActionFactory
- java.lang.Object
-
- com.inet.taskplanner.server.api.common.AbstractFactory<COMPONENT,DEFINITION,INFO,SUMMARY>
-
- com.inet.taskplanner.server.api.common.SeriesDependentFactory<T,com.inet.taskplanner.server.api.action.ResultActionDefinition,com.inet.taskplanner.server.api.action.ResultActionInfo,com.inet.taskplanner.server.api.common.SummaryInfo>
-
- com.inet.taskplanner.server.api.action.ResultActionFactory<com.inet.repository.taskplanner.RepositoryResultAction>
-
- com.inet.repository.taskplanner.RepositoryResultActionFactory
-
- All Implemented Interfaces:
com.inet.plugin.NamedExtension
public class RepositoryResultActionFactory extends com.inet.taskplanner.server.api.action.ResultActionFactory<com.inet.repository.taskplanner.RepositoryResultAction>
A result action factory for providing settings to save file results in a repository folder.- Since:
- taskplanner 3.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
EXTENSION_NAME
The extension name used to create aResultActionDefinition
.static java.lang.String
PROPERTY_FILENAME_FORMAT
The file name format of the target file.static java.lang.String
PROPERTY_REPOSITORY_FOLDER
Defines the folder in the repository to store the files in
-
Constructor Summary
Constructors Constructor Description RepositoryResultActionFactory()
Creates a new RepositoryResultActionFactory instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected com.inet.repository.taskplanner.RepositoryResultAction
createInstanceFrom(com.inet.taskplanner.server.api.action.ResultActionDefinition definition, com.inet.id.GUID taskID)
com.inet.taskplanner.server.api.action.ResultActionInfo
getInformation(com.inet.id.GUID taskID)
com.inet.taskplanner.server.api.common.SummaryInfo
getSummary(com.inet.taskplanner.server.api.action.ResultActionDefinition definition)
java.util.List<com.inet.taskplanner.server.api.result.ResultFlavor>
getSupportedFlavors(com.inet.taskplanner.server.api.action.ResultActionDefinition definition)
boolean
isAvailable()
protected void
validate(com.inet.taskplanner.server.api.action.ResultActionDefinition definition, com.inet.id.GUID taskID)
-
Methods inherited from class com.inet.taskplanner.server.api.action.ResultActionFactory
hasPlaceholderSet, isAutoResolvePlaceholders
-
Methods inherited from class com.inet.taskplanner.server.api.common.SeriesDependentFactory
createFrom, getFirstValueFromSeries, patchDefinitionProperties, updateValues, updateValues, validate
-
-
-
-
Field Detail
-
EXTENSION_NAME
public static final java.lang.String EXTENSION_NAME
The extension name used to create aResultActionDefinition
.- See Also:
- Constant Field Values
-
PROPERTY_FILENAME_FORMAT
public static final java.lang.String PROPERTY_FILENAME_FORMAT
The file name format of the target file. Can contain placeholders like [filename], [date] and [time]- See Also:
- Constant Field Values
-
PROPERTY_REPOSITORY_FOLDER
public static final java.lang.String PROPERTY_REPOSITORY_FOLDER
Defines the folder in the repository to store the files in- See Also:
- Constant Field Values
-
-
Method Detail
-
getSupportedFlavors
public java.util.List<com.inet.taskplanner.server.api.result.ResultFlavor> getSupportedFlavors(com.inet.taskplanner.server.api.action.ResultActionDefinition definition)
- Specified by:
getSupportedFlavors
in classcom.inet.taskplanner.server.api.action.ResultActionFactory<com.inet.repository.taskplanner.RepositoryResultAction>
-
getInformation
public com.inet.taskplanner.server.api.action.ResultActionInfo getInformation(com.inet.id.GUID taskID)
- Specified by:
getInformation
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.repository.taskplanner.RepositoryResultAction,com.inet.taskplanner.server.api.action.ResultActionDefinition,com.inet.taskplanner.server.api.action.ResultActionInfo,com.inet.taskplanner.server.api.common.SummaryInfo>
-
createInstanceFrom
protected com.inet.repository.taskplanner.RepositoryResultAction createInstanceFrom(com.inet.taskplanner.server.api.action.ResultActionDefinition definition, com.inet.id.GUID taskID)
- Overrides:
createInstanceFrom
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.repository.taskplanner.RepositoryResultAction,com.inet.taskplanner.server.api.action.ResultActionDefinition,com.inet.taskplanner.server.api.action.ResultActionInfo,com.inet.taskplanner.server.api.common.SummaryInfo>
-
validate
protected void validate(com.inet.taskplanner.server.api.action.ResultActionDefinition definition, com.inet.id.GUID taskID) throws com.inet.taskplanner.server.api.error.ValidationException
- Specified by:
validate
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.repository.taskplanner.RepositoryResultAction,com.inet.taskplanner.server.api.action.ResultActionDefinition,com.inet.taskplanner.server.api.action.ResultActionInfo,com.inet.taskplanner.server.api.common.SummaryInfo>
- Throws:
com.inet.taskplanner.server.api.error.ValidationException
-
getSummary
public com.inet.taskplanner.server.api.common.SummaryInfo getSummary(com.inet.taskplanner.server.api.action.ResultActionDefinition definition)
- Specified by:
getSummary
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.repository.taskplanner.RepositoryResultAction,com.inet.taskplanner.server.api.action.ResultActionDefinition,com.inet.taskplanner.server.api.action.ResultActionInfo,com.inet.taskplanner.server.api.common.SummaryInfo>
-
isAvailable
public boolean isAvailable()
- Overrides:
isAvailable
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.repository.taskplanner.RepositoryResultAction,com.inet.taskplanner.server.api.action.ResultActionDefinition,com.inet.taskplanner.server.api.action.ResultActionInfo,com.inet.taskplanner.server.api.common.SummaryInfo>
-
-