com.softwareag.centrasite.api.activity
Interface CreateAssetActivity

All Superinterfaces:
Activity, AttachDocumentAction, CSOAction

public interface CreateAssetActivity
extends Activity, AttachDocumentAction

The CreateAssetActivity enables you to create an asset from scratch with or without a file import. Assets of specific type like Service, XML Schema etc., have a main input file which can optionally include one or more internally referenced files. In such cases, the activity will import the main file and ask for any missing files that are internally referenced during the process of import.


Method Summary
 java.util.List<Organization> getApplicableOrganizations()
          Returns a list of organizations for which the user has Create Asset permission.
 java.util.List<CentraSiteRegistryObject> getAssets()
          Returns a list of newly created assets.
 java.util.Collection<CentraSiteRegistryObjectType> getAssetTypes()
          Returns the collection of top-level asset types
 java.lang.String getNewAssetId()
          Return the newly created asset.
 void setCreateNewAsset(boolean createNewAsset)
          creates the new asset instance based on the given inputs.
 void setDescription(java.lang.String description)
          Sets the description for the registry object that is being created as part of this activity
 void setName(java.lang.String name)
          Sets the name for the registry object that is being created as part of this activity
 void setSelectedOrganization(Organization organization)
          Sets the selected organization for the registry object that is being created as part of this activity
 void setSelectedType(CentraSiteRegistryObjectType type)
          Sets the selected asset type for the registry object that is being created as part of this activity
 void setUserVersion(java.lang.String userVersion)
          Sets the user version for the registry object that is being created as part of this activity
 
Methods inherited from interface com.softwareag.centrasite.api.activity.Activity
execute, isApplicable
 
Methods inherited from interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
getCurrentState, getExistingAssets, getMessage, getMissingFileName, getSupportedOptions, setAssetName, setCreateVersion, setCredentials, setDocument, setDocument, setInteractiveResolution, setOrigionalName, setOverwriteExisting, setReuseAsset
 
Methods inherited from interface com.softwareag.centrasite.api.csom.action.CSOAction
cancel, executeNextStep, executePreviousStep, finishAllSteps, getGroup, getIconURL, getId, getName, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
 

Method Detail

getAssetTypes

java.util.Collection<CentraSiteRegistryObjectType> getAssetTypes()
                                                                 throws CLLException
Returns the collection of top-level asset types

Returns:
collection of top-level asset types
Throws:
CLLException - if CLL fails to return all the top-level asset types

getApplicableOrganizations

java.util.List<Organization> getApplicableOrganizations()
                                                        throws CLLException
Returns a list of organizations for which the user has Create Asset permission. This list has the user's organization displayed as the first item; while the other organizations remain sorted by name.

Returns:
list of organizations for which user has Create Asset permission
Throws:
CLLException - if CLL fails to return the list of organizations

setSelectedType

void setSelectedType(CentraSiteRegistryObjectType type)
Sets the selected asset type for the registry object that is being created as part of this activity

Parameters:
type - Asset type to be set for the registry object

setSelectedOrganization

void setSelectedOrganization(Organization organization)
Sets the selected organization for the registry object that is being created as part of this activity

Parameters:
organization - Organization to be set for the registry object

setName

void setName(java.lang.String name)
Sets the name for the registry object that is being created as part of this activity

Parameters:
name - Name to be set for the registry object

setDescription

void setDescription(java.lang.String description)
Sets the description for the registry object that is being created as part of this activity

Parameters:
description - Description to be set for the registry object

setUserVersion

void setUserVersion(java.lang.String userVersion)
Sets the user version for the registry object that is being created as part of this activity

Specified by:
setUserVersion in interface AttachDocumentAction
Parameters:
userVersion - User version to be set for the registry object

getAssets

java.util.List<CentraSiteRegistryObject> getAssets()
                                                   throws CLLException
Returns a list of newly created assets. There can be as many assets created during a file upload based on the import levels.

Returns:
list of new assets
Throws:
CLLException - if CLL fails to return the list of new assets

setCreateNewAsset

void setCreateNewAsset(boolean createNewAsset)
creates the new asset instance based on the given inputs.

Parameters:
createNewAsset - true - in case user want to create new asset other wise false.

getNewAssetId

java.lang.String getNewAssetId()
                               throws CLLException
Return the newly created asset.

Returns:
newly created asset id.
Throws:
CLLException - in case of failed to get the asset id.