|
jBPM Designer - Backend 6.0.0.CR1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Repository
Repository is responsible for managing its components that are as follows:
Method Summary | |
---|---|
boolean |
assetExists(String assetUniqueId)
Examines repository if asset given by the assetUniqueId exists |
boolean |
copyAsset(String uniqueId,
String location)
Copy asset given by uniqueId into destination given by location |
boolean |
copyDirectory(String sourceDirectory,
String location)
Copy directory given by uniqueId into destination given by location |
String |
createAsset(Asset asset)
Stores given asset in the repository. |
Directory |
createDirectory(String location)
Stores new directory in given location, in case of sub folders existence in the location all sub folders are created as well. |
boolean |
deleteAsset(String assetUniqueId)
Deletes asset from repository identified by assetUniqueId if exists |
boolean |
deleteAssetFromPath(String path)
Deletes asset from repository given by the path if exists |
boolean |
deleteDirectory(String directory,
boolean failIfNotEmpty)
Deletes directory from repository including its content NOTE: Directory should be always relative to the repository root |
boolean |
directoryExists(String directory)
Examines repository if given directory exists in the repository NOTE: Directory should be always relative to the repository root |
String |
getName()
Returns name used to identify this repository. |
Collection<Asset> |
listAssets(String location)
Retrieves all assets stored in the given location. |
Collection<Asset> |
listAssets(String location,
Filter filter)
Retrieves all assets stored in the given location. |
Collection<Asset> |
listAssetsRecursively(String startAt,
Filter filter)
Retrieves all directories stored under startAt location including all sub folders. |
Collection<Directory> |
listDirectories(String startAt)
Retrieves all directories stored under startAt location. |
Asset |
loadAsset(String assetUniqueId)
Loads an asset given by the assetUniqueId including actual content of the asset. |
Asset |
loadAssetFromPath(String path)
Loads an asset given by the path including actual content of the asset. |
boolean |
moveAsset(String uniqueId,
String location,
String name)
Moves asset given by uniqueId into destination given by location
and renames it with given name |
boolean |
moveDirectory(String sourceDirectory,
String location,
String name)
Moves directory given by uniqueId into destination given by location
and renames it with given name |
String |
updateAsset(Asset asset)
Updates content of the asset |
Method Detail |
---|
String getName()
Collection<Directory> listDirectories(String startAt)
startAt
location.
NOTE: Directory should be always relative to the repository root
startAt
- - location where directories should be fetched from
Collection<Asset> listAssetsRecursively(String startAt, Filter filter)
startAt
location including all sub folders.
NOTE: Directory should be always relative to the repository root
startAt
- - location where directories should be fetched fromfilter
- - filter that allows to narrow the results
Directory createDirectory(String location)
location
- - location in the repository to be created
boolean directoryExists(String directory)
directory
- - directory to check
boolean deleteDirectory(String directory, boolean failIfNotEmpty)
directory
- - directory to be deletedfailIfNotEmpty
- - indicates if delete operation should fail in case given directory is not empty
boolean copyDirectory(String sourceDirectory, String location)
uniqueId
into destination given by location
sourceDirectory
- - source directory path relative to repository rootlocation
- - destination where directory will be copied to
boolean moveDirectory(String sourceDirectory, String location, String name)
uniqueId
into destination given by location
and renames it with given name
sourceDirectory
- - source directory path relative to repository rootlocation
- - final destination where directory should be moved toname
- - name of the directory after move, if null is given name is not changed
Collection<Asset> listAssets(String location)
location
- - location that assets should be collected from
Collection<Asset> listAssets(String location, Filter filter)
location
- - location that assets should be collected fromfilter
- - allows to defined filter criteria to fetch only assets of interest
Asset loadAsset(String assetUniqueId) throws AssetNotFoundException
assetUniqueId
including actual content of the asset.
assetUniqueId
- - unique identifier of the asset to load
AssetNotFoundException
- - throws in case of asset given by id does not existAsset loadAssetFromPath(String path) throws AssetNotFoundException
path
including actual content of the asset.
path
- - complete path of the asset to load (relative to the repository root)
AssetNotFoundException
- - throws in case of asset given by id does not existString createAsset(Asset asset)
asset
need to have all meta data and content available
for the operation to successfully complete.
asset
- - asset to be stored
String updateAsset(Asset asset) throws AssetNotFoundException
asset
- - asset to be stored with new content in it, all other data (like name, location) should be same
AssetNotFoundException
- - throws in case of asset given by id does not existboolean deleteAsset(String assetUniqueId)
assetUniqueId
if exists
assetUniqueId
- - unique identifier of the asset
boolean deleteAssetFromPath(String path)
path
if exists
path
- - complete path of the asset to delete
boolean assetExists(String assetUniqueId)
assetUniqueId
exists
assetUniqueId
- - unique identifier of the asset
boolean copyAsset(String uniqueId, String location)
uniqueId
into destination given by location
uniqueId
- - source asset unique idlocation
- - destination where asset will be copied to
boolean moveAsset(String uniqueId, String location, String name)
uniqueId
into destination given by location
and renames it with given name
uniqueId
- - source asset unique idlocation
- - final destination where asset should be moved toname
- - name of the asset after move, if null is given name is not changed
|
jBPM Designer - Backend 6.0.0.CR1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |