|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DataModuleService
Service interface for DataModule
specific operations.
Method Summary | |
---|---|
DataModule |
activateDataModule(String dataModuleID,
boolean updateDependencies)
Deprecated. |
DataModule |
copyDataModule(String oldDMID,
DataModule newDM)
Create a copy of the DataModule identified by the oldDMID . |
DataModule |
createDataModule(DataModule dm)
Create a new DataModule object. |
DataModule |
createTestDataModule(String dataModuleID)
Deprecated. |
boolean |
dataModuleExists(String dataModuleName)
Check if a DataModule exists by the given name. |
void |
deleteDataModule(String dataModuleID)
Deprecated. |
List |
getAllDataModules(Query query)
List all DataModule s filtered by the given Query . |
DataModule |
getDataModule(String dmID)
Fetch the DataModule identified by the given dmID . |
List |
getDependentDataModules(String moduleID)
Retrieve the list of other DataModule s (directly) dependent on the DataModule identified by the given
moduleID . |
List |
getDependentDataModules(String moduleID,
boolean fetchIndirectReferences)
Retrieve the list of other DataModule s dependent on the DataModule identified by the given
moduleID . |
List |
getDependentLetters(String moduleID)
Retrieve the list of Letter s (directly) dependent on the DataModule identified by the given
moduleID . |
List |
getDependentLetters(String moduleID,
boolean fetchIndirectReferences)
Retrieve the list of Letter s dependent on the DataModule identified by the given
moduleID . |
List |
getUsedDataModules(String moduleID,
boolean fetchIndirectReferences)
Retrieve the list of other DataModule s that is used by the DataModule identified by the given
moduleID . |
boolean |
isReferenced(String moduleID)
Check if this data module is being referenced by any other asset (Letter/DataModule). |
DataModule |
markReadyToPublish(String dataModuleID)
Mark as ready to publish the DataModule identified by the given dataModuleID . |
DataModule |
publishDataModule(String dataModuleID)
Publish the DataModule identified by the given dataModuleID . |
DataModule |
retrieveVersion(String dataModuleId,
Date publishDate)
Returns the version of dataModule that was published on or before the specified date. |
DataModule |
revertToLastPublished(String dataModuleId)
Reverts the data module to the last published version. |
DataModule |
updateDataModule(DataModule dm)
Update the given DataModule . |
boolean |
updateDependencies(DataModule oldModule,
DataModule newModule)
Update the references of the old data module oldModule , in any dependent assets,
with the new data module newModule . |
boolean |
updateDependencies(DataModule oldModule,
DataModule newModule,
List letters)
Update the references of the old data module oldModule , in any dependent assets (passed as third parameter),
with the new data module newModule . |
Method Detail |
---|
boolean dataModuleExists(String dataModuleName) throws ICCException
DataModule
exists by the given name.
dataModuleName
- Name of the DataModule
.
ICCException
DataModule createDataModule(DataModule dm) throws ICCException
DataModule
object.
dm
- The DataModule
to be created.
DataModule
object
ICCException
DataModule createTestDataModule(String dataModuleID) throws ICCException
DataModule
object.
dataModuleID
- ID of the DataModule
whose Inactive version is to be created.
DataModule
object.
ICCException
DataModule markReadyToPublish(String dataModuleID) throws ICCException
DataModule
identified by the given dataModuleID
.
dataModuleID
- ID of the DataModule
.
DataModule
object marked for publishing
ICCException
DataModule activateDataModule(String dataModuleID, boolean updateDependencies) throws ICCException
DataModule
identified by the given dataModuleID
.
dataModuleID
- ID of the DataModule
.updateDependencies
- Whether to set this new activated version in the dependencies.
DataModule
object
ICCException
DataModule publishDataModule(String dataModuleID) throws ICCException
DataModule
identified by the given dataModuleID
.
dataModuleID
- ID of the DataModule
.
DataModule
object
ICCException
void deleteDataModule(String dataModuleID) throws ICCException
DataModule
identified by the given dataModuleID
.
dataModuleID
- ID of the DataModule
.
ICCException
List getAllDataModules(Query query) throws ICCException
DataModule
s filtered by the given Query
.
query
- Query
to select data modules (supports only first level
attributes/properties of an object).DataModule
objects.
ICCException
Statement} and {@link Query}.
DataModule updateDataModule(DataModule dm) throws ICCException
DataModule
.
dm
- DataModule
object to be updated.
DataModule
object.
ICCException
DataModule getDataModule(String dmID) throws ICCException
DataModule
identified by the given dmID
.
dmID
- ID of the DataModule
to be fetched.
DataModule
identified by the given dmID
.
ICCException
DataModule copyDataModule(String oldDMID, DataModule newDM) throws ICCException
DataModule
identified by the oldDMID
.
newDM
does not have content in it, the content of the original module
is set in it.
oldDMID
- ID of the original DataModule
. Used to fetch the original content, if need be.newDM
- copy of the original Data Module (may have properties altered by the user)
DataModule
.
ICCException
List getDependentLetters(String moduleID) throws ICCException
Letter
s (directly) dependent on the DataModule
identified by the given
moduleID
.
DataModuleService.getDependentLetters(String, boolean)
moduleID
- ID of the DataModule
whose dependencies are to be fetched.
Letter
s which depend on the given DataModule
.
ICCException
DataModuleService.getDependentLetters(String, boolean)
List getDependentLetters(String moduleID, boolean fetchIndirectReferences) throws ICCException
Letter
s dependent on the DataModule
identified by the given
moduleID
.
moduleID
- ID of the DataModule
whose dependencies are to be fetched.fetchIndirectReferences
- True, if you wish to fetch the Letters that directly or indirectly use this module.
Letter
s which depend on the given DataModule
.
ICCException
List getDependentDataModules(String moduleID) throws ICCException
DataModule
s (directly) dependent on the DataModule
identified by the given
moduleID
.
DataModuleService.getDependentDataModules(String, boolean)
moduleID
- ID of the DataModule
whose dependencies are to be fetched.
DataModule
s dependent on the DataModule
.
ICCException
DataModuleService.getDependentDataModules(String, boolean)
List getDependentDataModules(String moduleID, boolean fetchIndirectReferences) throws ICCException
DataModule
s dependent on the DataModule
identified by the given
moduleID
.
moduleID
- ID of the DataModule
whose dependencies are to be fetched.fetchIndirectReferences
- True, if you wish to fetch the modules that directly or indirectly use this module.
DataModule
s dependent on the DataModule
.
ICCException
List getUsedDataModules(String moduleID, boolean fetchIndirectReferences) throws ICCException
DataModule
s that is used by the DataModule
identified by the given
moduleID
.
moduleID
- ID of the DataModule
, for which the used modules are to be fetched.fetchIndirectReferences
- True, if you wish to fetch the modules that are directly or indirectly used by this module.
DataModule
s that is used by the DataModule
. Empty list returned, if the
module does not use any other module.
ICCException
boolean isReferenced(String moduleID) throws ICCException
moduleID
- ID of the DataModule
whose dependencies are to be fetched.
ICCException
boolean updateDependencies(DataModule oldModule, DataModule newModule) throws ICCException
oldModule
, in any dependent assets,
with the new data module newModule
.
oldModule
- The old data module object.newModule
- The new data module object, which should be set as the new reference.
ICCException
boolean updateDependencies(DataModule oldModule, DataModule newModule, List letters) throws ICCException
oldModule
, in any dependent assets (passed as third parameter),
with the new data module newModule
.
oldModule
- The old data module object.newModule
- The new data module object, which should be set as the new reference.letters
- List of letters required to be updated.
ICCException
DataModule revertToLastPublished(String dataModuleId) throws ICCException
dataModuleId
- The data module ID.
ICCException
DataModule retrieveVersion(String dataModuleId, Date publishDate)
dataModuleId
- The Data module ID.publishDate
- specifies the date for fetching published data module.
ICCException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |