Package com.emc.d2fs.interfaces
Interface IVDContentService
- All Superinterfaces:
ID2fsService
Virtual Document management services.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Add child component to a virtual documentgetDialogForOperation
(Context context, String parentId, String childId, String operation, List<Attribute> attributes) getVDContent
(Context context, String id, List<Attribute> options) Get tree content of virtual documentinsertInheritedComponent
(Context context, String srcVdId, String vdTemplateName, String inheritedComponentId, boolean overrideExistingComponent, List<Attribute> attributes) Inserts an inherited component as child element based on a VD templateboolean
moveVDChild
(Context context, String srcParentId, String tgtParentId, String moveId, String moveNum, String toNum, List<Attribute> attributes) Move within VDboolean
removeVDChild
(Context context, String parentId, int childIdx, List<Attribute> attributes) Remove child VDboolean
replaceVDChild
(Context context, String vdocId, int childIndex, String newDocId, List<Attribute> attributes) Replace child VD.boolean
setVDChildBindingVersions
(Context context, String parentId, String childIdx, String versionLabel, List<Attribute> attributes) Set binding version for a child componentsMethods inherited from interface com.emc.d2fs.interfaces.ID2fsService
isRemote, setRemote
-
Method Details
-
getVDContent
Get tree content of virtual document- Parameters:
context
-Context
object containing informations about client/sessionid
- String value of document idoptions
- List of attrbutes- vdShowVersion - boolean true to include version information.
- vdShowNumber - boolean true to include virtual document numbers.
- Returns:
- Node as content
- Throws:
Exception
- Since:
- 4.0.1
-
addVDChild
boolean addVDChild(Context context, String vdId, int childIdx, String childId, List<Attribute> attributes) throws Exception Add child component to a virtual document- Parameters:
context
-Context
object containing informations about client/sessionvdId
- String value of virtual document idchildIdx
- integer value of insert indexchildId
- String value of child document idattributes
- List of attributes- confirm - (optional) true to confirm any warnings returned as exceptions.
- Returns:
- true if successfully
- Throws:
Exception
- Since:
- 4.1.0
-
moveVDChild
boolean moveVDChild(Context context, String srcParentId, String tgtParentId, String moveId, String moveNum, String toNum, List<Attribute> attributes) throws Exception Move within VD- Parameters:
context
-Context
object containing informations about client/sessionsrcParentId
- Id of the source VDtgtParentId
- Id of the target VDmoveId
- Id if the document to be movedmoveNum
- Index number of the item to move.toNum
- Index number if the target position.attributes
- List of attributes- confirm - (optional) true to confirm any warnings returned as exceptions.
- Returns:
- true if successful
- Throws:
Exception
- Since:
- 4.1.0
-
removeVDChild
boolean removeVDChild(Context context, String parentId, int childIdx, List<Attribute> attributes) throws Exception Remove child VD- Parameters:
context
-Context
object containing informations about client/sessionparentId
- Id the the VD to be modifiedchildIdx
- Index of the child to remove.attributes
- List of attributes- confirm - (optional) true to confirm any warnings returned as exceptions.
- Returns:
- true if successful
- Throws:
Exception
-
setVDChildBindingVersions
boolean setVDChildBindingVersions(Context context, String parentId, String childIdx, String versionLabel, List<Attribute> attributes) throws Exception Set binding version for a child components- Parameters:
context
-Context
object containing informations about client/sessionparentId
- Id of the VD to modify.childIdx
- Index of the child to set the binding version.versionLabel
- Label of version to be bound (ie. "CURRENT", "1.0", "2.0")attributes
- List of attributes- confirm - (optional) true to confirm any warnings returned as exceptions.
- Returns:
- true if successful
- Throws:
Exception
- Since:
- 4.1.0
-
insertInheritedComponent
String insertInheritedComponent(Context context, String srcVdId, String vdTemplateName, String inheritedComponentId, boolean overrideExistingComponent, List<Attribute> attributes) throws Exception Inserts an inherited component as child element based on a VD template- Parameters:
context
-Context
object containing informations about client/sessionsrcVdId
- Id of the VD to modifyvdTemplateName
- Virtual document template nameinheritedComponentId
- Id of the VD from which to inheritoverrideExistingComponent
- Boolean true to override.attributes
- List of attributes- confirm - (optional) true to confirm any warnings returned as exceptions.
- Returns:
- String which contains a delimited ';' list of new objects if successful
- Throws:
Exception
- Since:
- 4.1.0
-
getDialogForOperation
String getDialogForOperation(Context context, String parentId, String childId, String operation, List<Attribute> attributes) throws Exception - Parameters:
context
-Context
object containing informations about client/sessionparentId
- Id of the parentchildId
- Id of the document for the operationoperation
- operation on the VD to be doneattributes
- List of attributes- Returns:
- the dialog name to be used instead of default VD operation
- Throws:
Exception
- Since:
- 4.2.1
-
replaceVDChild
boolean replaceVDChild(Context context, String vdocId, int childIndex, String newDocId, List<Attribute> attributes) throws Exception Replace child VD.- Parameters:
context
-Context
object containing informations about client/session.vdocId
- Id the the VD to be modified.childIndex
- Index of the child to replace.newDocId
- The new document ID to be replaced with.attributes
- List of attributes- confirm - (optional) true to confirm any warnings returned as exceptions.
- Returns:
- true if successful.
- Throws:
Exception
- Since:
- 16.3.0
-