public interface AnalysisService
Modifier and Type | Method and Description |
---|---|
boolean |
analysisExists(ProjectDescriptor project,
String name)
Checks if the analysis specified by name exists for the specified project.
|
Analysis |
createAnalysis(ProjectDescriptor projectContext,
String analysisName,
List<Attribute> attributes)
Create an analysis in the specified project.
|
void |
deleteAnalysis(AnalysisDescriptor analysis)
Delete the specified analysis and all of its children.
|
List<Analysis> |
getAnalysesByProject(ProjectDescriptor project)
Get all the analyses defined in the specified project.
|
Analysis |
getAnalysisByIdentifier(String identifier)
Get the analysis specified by its identifier.
|
Analysis |
getAnalysisByName(ProjectDescriptor project,
String name)
Get the analysis specified by name in the given project.
|
AnalysisDescriptor |
getAnalysisDescriptorByIdentifier(String identifier)
Get the light-weight representation of the analysis specified by its identifier.
|
AnalysisDescriptor |
getAnalysisDescriptorByName(ProjectDescriptor project,
String name)
Get the light-weight representation of the analysis specified by name in the given project.
|
List<AnalysisDescriptor> |
getAnalysisDescriptorsByProject(ProjectDescriptor project)
Get light-weight representations of all the analyses defined in the specified project.
|
List<AttributeDefinition> |
getAttributeDefinitionsForAnalysis()
Get the set of attribute definitions on the analysis type including system and extended attributes.
|
List<AttributeDefinition> |
getAttributeDefinitionsForAnalysisType()
Deprecated.
As of Java API 1.7. Replaced with
getAttributeDefinitionsForAnalysis() . |
List<Attribute> |
getCreationAttributesForAnalysis()
Get the set of attributes that may be specified when creating an analysis.
|
List<Attribute> |
getCreationAttributesForAnalysisType()
Deprecated.
As of Java API 1.7. Replaced with
getCreationAttributesForAnalysis() . |
Analysis |
renameAnalysis(Analysis analysis,
String newName)
Rename the specified analysis with the new name specified.
|
Analysis |
setAnalysisState(AnalysisDescriptor analysisDescriptor,
State state,
String comment)
Set the state for the analysis
|
Analysis |
updateAnalysis(Analysis analysis)
Updates an analysis.
|
Analysis createAnalysis(ProjectDescriptor projectContext, String analysisName, List<Attribute> attributes) throws ProjectNotFoundException, AnalysisExistsException
projectContext
- The parent project of the analysis to be created.analysisName
- The name of the analysis to create.attributes
- A collection of Attribute
objects associated with the Analysis type
that can be specified at creation. Use
getCreationAttributesForAnalysisType()
to get the
collection of creation attributes.ProjectNotFoundException
- The specified parent project was not found.AnalysisExistsException
- An analysis with this name already exists.Analysis updateAnalysis(Analysis analysis) throws AnalysisNotFoundException
analysis
- The analysis to updateAnalysisNotFoundException
- An analysis with the specified identifier could not be found.AnalysisDescriptor.setAttributes(List)
,
Analysis.setLead(String)
boolean analysisExists(ProjectDescriptor project, String name)
project
- The parent project of the analysis in question.name
- The name of the analysis in question.Analysis getAnalysisByIdentifier(String identifier) throws AnalysisNotFoundException
identifier
- analysis identifier which uniquely identifies this object in the systemAnalysisNotFoundException
- An analysis with the specified identifier could not be found.Analysis getAnalysisByName(ProjectDescriptor project, String name) throws AnalysisNotFoundException
project
- The parent project of the desired analysis.name
- analysis name The name of the desired analysis.AnalysisNotFoundException
- The specified analysis could not be found.AnalysisDescriptor getAnalysisDescriptorByIdentifier(String identifier) throws AnalysisNotFoundException
identifier
- The identifier of the desired analysis.AnalysisNotFoundException
- An analysis with the specified identifier could not be found.AnalysisDescriptor getAnalysisDescriptorByName(ProjectDescriptor project, String name) throws AnalysisNotFoundException
project
- The parent project of the desired analysis.name
- The name of the desired analysis.AnalysisNotFoundException
- An analysis with the specified name could not be found in the specified
project.List<AnalysisDescriptor> getAnalysisDescriptorsByProject(ProjectDescriptor project) throws ProjectNotFoundException
project
- The parent project of the desired analyses.ProjectNotFoundException
- The specified parent project was not found.List<Analysis> getAnalysesByProject(ProjectDescriptor project) throws ProjectNotFoundException
project
- The parent project of the desired analysis.ProjectNotFoundException
- The specified parent project was not found.Analysis renameAnalysis(Analysis analysis, String newName) throws AnalysisNotFoundException, AnalysisRenameException
analysis
- The analysis to be renamed.newName
- The new name to give to the analysis.AnalysisNotFoundException
- The analysis to be renamed does not exist.AnalysisRenameException
- The analysis can not be renamed (Check exception to see if name is too long, is
illegal, or is already being used).void deleteAnalysis(AnalysisDescriptor analysis) throws AnalysisNotFoundException
analysis
- The analysis to be deleted.AnalysisNotFoundException
- The specified analysis does not exist.@Deprecated List<Attribute> getCreationAttributesForAnalysisType() throws TypeNotFoundException
getCreationAttributesForAnalysis()
.TypeNotFoundException
List<Attribute> getCreationAttributesForAnalysis() throws TypeNotFoundException
TypeNotFoundException
@Deprecated List<AttributeDefinition> getAttributeDefinitionsForAnalysisType() throws TypeNotFoundException
getAttributeDefinitionsForAnalysis()
.TypeNotFoundException
List<AttributeDefinition> getAttributeDefinitionsForAnalysis() throws TypeNotFoundException
TypeNotFoundException
Analysis setAnalysisState(AnalysisDescriptor analysisDescriptor, State state, String comment) throws AnalysisNotFoundException, AnalysisStateException
analysisDescriptor
- The light-weight representation of the analysisstate
- The state to set on the analysiscomment
- Optionally, a comment about the state changeAnalysisNotFoundException
- The analysis state could not be set.AnalysisStateException
- The specified analysis does not exist.Copyright (c) 2017, SAS Institute Inc., Cary, NC, USA