public interface IDocumentContentDataProvider
IDocumentContentDataProvider allows to access Document Contents of a COCKPIT project
for document generation. The IDocumentContentDataProvider can be referenced directly within a
document template by its name documentContentDataProvider.| Modifier and Type | Method and Description |
|---|---|
IFolder |
findFolder(java.lang.String path)
Searches for the folder item with the specified path.
|
java.util.List<? extends IContainer> |
getAllContainers()
Returns all container items of the project.
|
java.util.List<? extends IContainer> |
getAllContainers(int sortingCriterion)
Returns all container items of the project.
|
java.util.List<? extends IContainer> |
getAllContainers(java.lang.String sortingProperty)
Returns all container items of the project.
|
java.util.List<? extends IContainer> |
getAllContainersForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Returns all container items which have been modified the last time with the commit
identified by the given history item (each time, a user commits the project,
a history item is created).
|
java.util.List<? extends IContainer> |
getAllContainersForModelElement(java.lang.String modelElementUID)
Returns all container items of the project which are linked to the given model element.
|
java.util.List<? extends IContainer> |
getAllContainersForModelElement(java.lang.String modelElementUID,
int sortingCriterion)
Returns all container items of the project which are linked to the given model element.
|
java.util.List<? extends IContainer> |
getAllContainersForModelElement(java.lang.String modelElementUID,
java.lang.String sortingProperty)
Returns all container items of the project which are linked to the given model element.
|
java.util.List<? extends IContainer> |
getAllContainersNotLinkedToAnyModelElement()
Returns all container items of the project which are not linked to any model element.
|
java.util.List<? extends IContainer> |
getAllContainersNotLinkedToAnyModelElement(int sortingCriterion)
Returns all container items of the project which are not linked to any model element.
|
java.util.List<? extends IContainer> |
getAllContainersNotLinkedToAnyModelElement(java.lang.String sortingProperty)
Returns all container items of the project which are not linked to any model element.
|
java.util.List<? extends IContainer> |
getAllContainersWithCategory(java.lang.String categoryID)
Returns all container items of the project that belong to the specified category.
|
java.util.List<? extends IContainer> |
getAllContainersWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all container items of the project that belong to the specified category.
|
java.util.List<? extends IContainer> |
getAllContainersWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all container items of the project that belong to the specified category.
|
java.util.List<? extends IContainer> |
getAllContainersWithDefaultCategory()
Returns all container items of the project that belong to the default category.
|
java.util.List<? extends IContainer> |
getAllContainersWithDefaultCategory(int sortingCriterion)
Returns all container items of the project that belong to the default category.
|
java.util.List<? extends IContainer> |
getAllContainersWithDefaultCategory(java.lang.String sortingProperty)
Returns all container items of the project that belong to the default category.
|
java.util.List<? extends ICrossReference> |
getAllCrossReferences()
Returns all cross reference items of the project.
|
java.util.List<? extends ICrossReference> |
getAllCrossReferences(int sortingCriterion)
Returns all cross reference items of the project.
|
java.util.List<? extends ICrossReference> |
getAllCrossReferences(java.lang.String sortingProperty)
Returns all cross reference items of the project.
|
java.util.List<? extends ICrossReference> |
getAllCrossReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Returns all cross reference items which have been modified the last time with the commit
identified by the given history item (each time, a user commits the project,
a history item is created).
|
java.util.List<? extends ICrossReference> |
getAllCrossReferencesWithCategory(java.lang.String categoryID)
Returns all cross reference items of the project that belong to the specified category.
|
java.util.List<? extends ICrossReference> |
getAllCrossReferencesWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all cross reference items of the project that belong to the specified category.
|
java.util.List<? extends ICrossReference> |
getAllCrossReferencesWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all cross reference items of the project that belong to the specified category.
|
java.util.List<? extends ICrossReference> |
getAllCrossReferencesWithDefaultCategory()
Returns all cross reference items of the project that belong to the default category.
|
java.util.List<? extends ICrossReference> |
getAllCrossReferencesWithDefaultCategory(int sortingCriterion)
Returns all cross reference items of the project that belong to the default category.
|
java.util.List<? extends ICrossReference> |
getAllCrossReferencesWithDefaultCategory(java.lang.String sortingProperty)
Returns all cross reference items of the project that belong to the default category.
|
java.util.List<? extends IFolderReference> |
getAllFolderReferences()
Returns all folder reference items of the project.
|
java.util.List<? extends IFolderReference> |
getAllFolderReferences(int sortingCriterion)
Returns all folder reference items of the project.
|
java.util.List<? extends IFolderReference> |
getAllFolderReferences(java.lang.String sortingProperty)
Returns all folder reference items of the project.
|
java.util.List<? extends IFolderReference> |
getAllFolderReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Returns all folder reference items which have been modified the last time with the commit
identified by the given history item (each time, a user commits the project,
a history item is created).
|
java.util.List<? extends IFolderReference> |
getAllFolderReferencesWithCategory(java.lang.String categoryID)
Returns all folder reference items of the project that belong to the specified category.
|
java.util.List<? extends IFolderReference> |
getAllFolderReferencesWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all folder reference items of the project that belong to the specified category.
|
java.util.List<? extends IFolderReference> |
getAllFolderReferencesWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all folder reference items of the project that belong to the specified category.
|
java.util.List<? extends IFolderReference> |
getAllFolderReferencesWithDefaultCategory()
Returns all folder reference items of the project that belong to the default category.
|
java.util.List<? extends IFolderReference> |
getAllFolderReferencesWithDefaultCategory(int sortingCriterion)
Returns all folder reference items of the project that belong to the default category.
|
java.util.List<? extends IFolderReference> |
getAllFolderReferencesWithDefaultCategory(java.lang.String sortingProperty)
Returns all folder reference items of the project that belong to the default category.
|
java.util.List<? extends IFolder> |
getAllFolders()
Returns all folder items of the project.
|
java.util.List<? extends IFolder> |
getAllFolders(int sortingCriterion)
Returns all folder items of the project.
|
java.util.List<? extends IFolder> |
getAllFolders(java.lang.String sortingProperty)
Returns all folder items of the project.
|
java.util.List<? extends IFolder> |
getAllFoldersForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Returns all folder items which have been modified the last time with the commit
identified by the given history item (each time, a user commits the project,
a history item is created).
|
java.util.List<? extends IFolder> |
getAllFoldersWithCategory(java.lang.String categoryID)
Returns all folder items of the project that belong to the specified category.
|
java.util.List<? extends IFolder> |
getAllFoldersWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all folder items of the project that belong to the specified category.
|
java.util.List<? extends IFolder> |
getAllFoldersWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all folder items of the project that belong to the specified category.
|
java.util.List<? extends IFolder> |
getAllFoldersWithDefaultCategory()
Returns all folder items of the project that belong to the default category.
|
java.util.List<? extends IFolder> |
getAllFoldersWithDefaultCategory(int sortingCriterion)
Returns all folder items of the project that belong to the default category.
|
java.util.List<? extends IFolder> |
getAllFoldersWithDefaultCategory(java.lang.String sortingProperty)
Returns all folder items of the project that belong to the default category.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferences()
Returns all model element reference items of the project.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferences(int sortingCriterion)
Returns all model element reference items of the project.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferences(java.lang.String sortingProperty)
Returns all model element reference items of the project.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Returns all model element reference items which have been modified the last time with the commit
identified by the given history item (each time, a user commits the project,
a history item is created).
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesForModelElement(java.lang.String modelElementUID)
Returns all model element reference items of the project which are linked to the given model element.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesForModelElement(java.lang.String modelElementUID,
int sortingCriterion)
Returns all model element reference items of the project which are linked to the given model element.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesForModelElement(java.lang.String modelElementUID,
java.lang.String sortingProperty)
Returns all model element reference items of the project which are linked to the given model element.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesNotLinkedToAnyModelElement()
Returns all model element reference items of the project which are not linked to any model element.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesNotLinkedToAnyModelElement(int sortingCriterion)
Returns all model element reference items of the project which are not linked to any model element.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesNotLinkedToAnyModelElement(java.lang.String sortingProperty)
Returns all model element reference items of the project which are not linked to any model element.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesWithCategory(java.lang.String categoryID)
Returns all model element reference items of the project that belong to the specified category.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all model element reference items of the project that belong to the specified category.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all model element reference items of the project that belong to the specified category.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesWithDefaultCategory()
Returns all model element reference items of the project that belong to the default category.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesWithDefaultCategory(int sortingCriterion)
Returns all model element reference items of the project that belong to the default category.
|
java.util.List<? extends IModelElementReference> |
getAllModelElementReferencesWithDefaultCategory(java.lang.String sortingProperty)
Returns all model element reference items of the project that belong to the default category.
|
java.util.List<? extends IPictureReference> |
getAllPictureReferences()
Returns all picture reference items of the project.
|
java.util.List<? extends IPictureReference> |
getAllPictureReferences(int sortingCriterion)
Returns all picture reference items of the project.
|
java.util.List<? extends IPictureReference> |
getAllPictureReferences(java.lang.String sortingProperty)
Returns all picture reference items of the project.
|
java.util.List<? extends IPictureReference> |
getAllPictureReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Returns all picture reference items which have been modified the last time with the commit
identified by the given history item (each time, a user commits the project,
a history item is created).
|
java.util.List<? extends IPictureReference> |
getAllPictureReferencesWithCategory(java.lang.String categoryID)
Returns all picture reference items of the project that belong to the specified category.
|
java.util.List<? extends IPictureReference> |
getAllPictureReferencesWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all picture reference items of the project that belong to the specified category.
|
java.util.List<? extends IPictureReference> |
getAllPictureReferencesWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all picture reference items of the project that belong to the specified category.
|
java.util.List<? extends IPictureReference> |
getAllPictureReferencesWithDefaultCategory()
Returns all picture reference items of the project that belong to the default category.
|
java.util.List<? extends IPictureReference> |
getAllPictureReferencesWithDefaultCategory(int sortingCriterion)
Returns all picture reference items of the project that belong to the default category.
|
java.util.List<? extends IPictureReference> |
getAllPictureReferencesWithDefaultCategory(java.lang.String sortingProperty)
Returns all picture reference items of the project that belong to the default category.
|
java.util.List<? extends IPicture> |
getAllPictures()
Returns all picture items of the project.
|
java.util.List<? extends IPicture> |
getAllPictures(int sortingCriterion)
Returns all picture items of the project.
|
java.util.List<? extends IPicture> |
getAllPictures(java.lang.String sortingProperty)
Returns all picture items of the project.
|
java.util.List<? extends IPicture> |
getAllPicturesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Returns all picture items which have been modified the last time with the commit
identified by the given history item (each time, a user commits the project,
a history item is created).
|
java.util.List<? extends IPicture> |
getAllPicturesWithCategory(java.lang.String categoryID)
Returns all picture items of the project that belong to the specified category.
|
java.util.List<? extends IPicture> |
getAllPicturesWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all picture items of the project that belong to the specified category.
|
java.util.List<? extends IPicture> |
getAllPicturesWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all picture items of the project that belong to the specified category.
|
java.util.List<? extends IPicture> |
getAllPicturesWithDefaultCategory()
Returns all picture items of the project that belong to the default category.
|
java.util.List<? extends IPicture> |
getAllPicturesWithDefaultCategory(int sortingCriterion)
Returns all picture items of the project that belong to the default category.
|
java.util.List<? extends IPicture> |
getAllPicturesWithDefaultCategory(java.lang.String sortingProperty)
Returns all picture items of the project that belong to the default category.
|
java.util.List<? extends IPlanReference> |
getAllPlanReferences()
Returns all plan reference items of the project.
|
java.util.List<? extends IPlanReference> |
getAllPlanReferences(int sortingCriterion)
Returns all plan reference items of the project.
|
java.util.List<? extends IPlanReference> |
getAllPlanReferences(java.lang.String sortingProperty)
Returns all plan reference items of the project.
|
java.util.List<? extends IPlanReference> |
getAllPlanReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Returns all plan reference items which have been modified the last time with the commit
identified by the given history item (each time, a user commits the project,
a history item is created).
|
java.util.List<? extends IPlanReference> |
getAllPlanReferencesWithCategory(java.lang.String categoryID)
Returns all plan reference items of the project that belong to the specified category.
|
java.util.List<? extends IPlanReference> |
getAllPlanReferencesWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all plan reference items of the project that belong to the specified category.
|
java.util.List<? extends IPlanReference> |
getAllPlanReferencesWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all plan reference items of the project that belong to the specified category.
|
java.util.List<? extends IPlanReference> |
getAllPlanReferencesWithDefaultCategory()
Returns all plan reference items of the project that belong to the default category.
|
java.util.List<? extends IPlanReference> |
getAllPlanReferencesWithDefaultCategory(int sortingCriterion)
Returns all plan reference items of the project that belong to the default category.
|
java.util.List<? extends IPlanReference> |
getAllPlanReferencesWithDefaultCategory(java.lang.String sortingProperty)
Returns all plan reference items of the project that belong to the default category.
|
java.util.List<? extends IRoleReference> |
getAllRoleReferences()
Returns all role reference items of the project.
|
java.util.List<? extends IRoleReference> |
getAllRoleReferences(int sortingCriterion)
Returns all role reference items of the project.
|
java.util.List<? extends IRoleReference> |
getAllRoleReferences(java.lang.String sortingProperty)
Returns all role reference items of the project.
|
java.util.List<? extends IRoleReference> |
getAllRoleReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Returns all role reference items which have been modified the last time with the commit
identified by the given history item (each time, a user commits the project,
a history item is created).
|
java.util.List<? extends IRoleReference> |
getAllRoleReferencesWithCategory(java.lang.String categoryID)
Returns all role reference items of the project that belong to the specified category.
|
java.util.List<? extends IRoleReference> |
getAllRoleReferencesWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all role reference items of the project that belong to the specified category.
|
java.util.List<? extends IRoleReference> |
getAllRoleReferencesWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all role reference items of the project that belong to the specified category.
|
java.util.List<? extends IRoleReference> |
getAllRoleReferencesWithDefaultCategory()
Returns all role reference items of the project that belong to the default category.
|
java.util.List<? extends IRoleReference> |
getAllRoleReferencesWithDefaultCategory(int sortingCriterion)
Returns all role reference items of the project that belong to the default category.
|
java.util.List<? extends IRoleReference> |
getAllRoleReferencesWithDefaultCategory(java.lang.String sortingProperty)
Returns all role reference items of the project that belong to the default category.
|
java.util.List<? extends IFolder> |
getAllRootFolders()
Returns all root folder items of the project.
|
java.util.List<? extends IFolder> |
getAllRootFolders(int sortingCriterion)
Returns all root folder items of the project.
|
java.util.List<? extends IFolder> |
getAllRootFolders(java.lang.String sortingProperty)
Returns all root folder items of the project.
|
java.util.List<? extends IFolder> |
getAllRootFoldersWithCategory(java.lang.String categoryID)
Returns all root folder items of the project that belong to the specified category.
|
java.util.List<? extends IFolder> |
getAllRootFoldersWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all root folder items of the project that belong to the specified category.
|
java.util.List<? extends IFolder> |
getAllRootFoldersWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all root folder items of the project that belong to the specified category.
|
java.util.List<? extends IFolder> |
getAllRootFoldersWithDefaultCategory()
Returns all root folder items of the project that belong to the default category.
|
java.util.List<? extends IFolder> |
getAllRootFoldersWithDefaultCategory(int sortingCriterion)
Returns all root folder items of the project that belong to the default category.
|
java.util.List<? extends IFolder> |
getAllRootFoldersWithDefaultCategory(java.lang.String sortingProperty)
Returns all root folder items of the project that belong to the default category.
|
java.util.List<? extends IStakeholderReference> |
getAllStakeholderReferences()
Returns all stakeholder reference items of the project.
|
java.util.List<? extends IStakeholderReference> |
getAllStakeholderReferences(int sortingCriterion)
Returns all stakeholder reference items of the project.
|
java.util.List<? extends IStakeholderReference> |
getAllStakeholderReferences(java.lang.String sortingProperty)
Returns all stakeholder reference items of the project.
|
java.util.List<? extends IStakeholderReference> |
getAllStakeholderReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Returns all stakeholder reference items which have been modified the last time with the commit
identified by the given history item (each time, a user commits the project,
a history item is created).
|
java.util.List<? extends IStakeholderReference> |
getAllStakeholderReferencesWithCategory(java.lang.String categoryID)
Returns all stakeholder reference items of the project that belong to the specified category.
|
java.util.List<? extends IStakeholderReference> |
getAllStakeholderReferencesWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all stakeholder reference items of the project that belong to the specified category.
|
java.util.List<? extends IStakeholderReference> |
getAllStakeholderReferencesWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all stakeholder reference items of the project that belong to the specified category.
|
java.util.List<? extends IStakeholderReference> |
getAllStakeholderReferencesWithDefaultCategory()
Returns all stakeholder reference items of the project that belong to the default category.
|
java.util.List<? extends IStakeholderReference> |
getAllStakeholderReferencesWithDefaultCategory(int sortingCriterion)
Returns all stakeholder reference items of the project that belong to the default category.
|
java.util.List<? extends IStakeholderReference> |
getAllStakeholderReferencesWithDefaultCategory(java.lang.String sortingProperty)
Returns all stakeholder reference items of the project that belong to the default category.
|
java.util.List<? extends ITextReference> |
getAllTextReferences()
Returns all text reference items of the project.
|
java.util.List<? extends ITextReference> |
getAllTextReferences(int sortingCriterion)
Returns all text reference items of the project.
|
java.util.List<? extends ITextReference> |
getAllTextReferences(java.lang.String sortingProperty)
Returns all text reference items of the project.
|
java.util.List<? extends ITextReference> |
getAllTextReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Returns all text reference items which have been modified the last time with the commit
identified by the given history item (each time, a user commits the project,
a history item is created).
|
java.util.List<? extends ITextReference> |
getAllTextReferencesWithCategory(java.lang.String categoryID)
Returns all text reference items of the project that belong to the specified category.
|
java.util.List<? extends ITextReference> |
getAllTextReferencesWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all text reference items of the project that belong to the specified category.
|
java.util.List<? extends ITextReference> |
getAllTextReferencesWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all text reference items of the project that belong to the specified category.
|
java.util.List<? extends ITextReference> |
getAllTextReferencesWithDefaultCategory()
Returns all text reference items of the project that belong to the default category.
|
java.util.List<? extends ITextReference> |
getAllTextReferencesWithDefaultCategory(int sortingCriterion)
Returns all text reference items of the project that belong to the default category.
|
java.util.List<? extends ITextReference> |
getAllTextReferencesWithDefaultCategory(java.lang.String sortingProperty)
Returns all text reference items of the project that belong to the default category.
|
java.util.List<? extends IText> |
getAllTexts()
Returns all text items of the project.
|
java.util.List<? extends IText> |
getAllTexts(int sortingCriterion)
Returns all text items of the project.
|
java.util.List<? extends IText> |
getAllTexts(java.lang.String sortingProperty)
Returns all text items of the project.
|
java.util.List<? extends IText> |
getAllTextsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Returns all text items which have been modified the last time with the commit
identified by the given history item (each time, a user commits the project,
a history item is created).
|
java.util.List<? extends IText> |
getAllTextsWithCategory(java.lang.String categoryID)
Returns all text items of the project that belong to the specified category.
|
java.util.List<? extends IText> |
getAllTextsWithCategory(java.lang.String categoryID,
int sortingCriterion)
Returns all text items of the project that belong to the specified category.
|
java.util.List<? extends IText> |
getAllTextsWithCategory(java.lang.String categoryID,
java.lang.String sortingProperty)
Returns all text items of the project that belong to the specified category.
|
java.util.List<? extends IText> |
getAllTextsWithDefaultCategory()
Returns all text items of the project that belong to the default category.
|
java.util.List<? extends IText> |
getAllTextsWithDefaultCategory(int sortingCriterion)
Returns all text items of the project that belong to the default category.
|
java.util.List<? extends IText> |
getAllTextsWithDefaultCategory(java.lang.String sortingProperty)
Returns all text items of the project that belong to the default category.
|
int |
getSORT_CONTAINER_BY_NAME()
Constant for sorting container items by name.
|
int |
getSORT_CROSSREFERENCE_BY_NAME()
Constant for sorting cross reference items by name.
|
int |
getSORT_FOLDER_BY_NAME()
Constant for sorting folder items by name.
|
int |
getSORT_FOLDERREFERENCE_BY_FOLDER()
Constant for sorting folder reference items by folder.
|
int |
getSORT_FOLDERREFERENCE_BY_NAME()
Constant for sorting folder reference items by name.
|
int |
getSORT_MODELELEMENTREFERENCE_BY_NAME()
Constant for sorting model element reference items by name.
|
int |
getSORT_PICTURE_BY_ID()
Constant for sorting picture items by id.
|
int |
getSORT_PICTURE_BY_IDANDNAME()
Constant for sorting picture items by id and name.
|
int |
getSORT_PICTURE_BY_NAME()
Constant for sorting picture items by name.
|
int |
getSORT_PICTUREREFERENCE_BY_NAME()
Constant for sorting picture reference items by name.
|
int |
getSORT_PLANREFERENCE_BY_NAME()
Constant for sorting plan reference items by name.
|
int |
getSORT_PLANREFERENCE_BY_PLAN()
Constant for sorting plan reference items by plan.
|
int |
getSORT_ROLEREFERENCE_BY_NAME()
Constant for sorting role reference items by name.
|
int |
getSORT_ROLEREFERENCE_BY_ROLE()
Constant for sorting role reference items by role.
|
int |
getSORT_STAKEHOLDERREFERENCE_BY_NAME()
Constant for sorting stakeholder reference items by name.
|
int |
getSORT_STAKEHOLDERREFERENCE_BY_STAKEHOLDER()
Constant for sorting stakeholder reference items by stakeholder.
|
int |
getSORT_TEXT_BY_ID()
Constant for sorting text items by id.
|
int |
getSORT_TEXT_BY_IDANDNAME()
Constant for sorting text items by id and name.
|
int |
getSORT_TEXT_BY_NAME()
Constant for sorting text items by name.
|
int |
getSORT_TEXTREFERENCE_BY_NAME()
Constant for sorting text reference items by name.
|
boolean |
hasContainersForModelElement(java.lang.String modelElementUID)
Returns whether there are any container items linked to the specified model element.
|
boolean |
hasModelElementReferencesForModelElement(java.lang.String modelElementUID)
Returns whether there are any model element reference items linked to the specified model element.
|
int getSORT_FOLDER_BY_NAME()
int getSORT_CONTAINER_BY_NAME()
int getSORT_TEXT_BY_ID()
int getSORT_TEXT_BY_NAME()
int getSORT_TEXT_BY_IDANDNAME()
int getSORT_TEXTREFERENCE_BY_NAME()
int getSORT_PICTURE_BY_ID()
int getSORT_PICTURE_BY_NAME()
int getSORT_PICTURE_BY_IDANDNAME()
int getSORT_PICTUREREFERENCE_BY_NAME()
int getSORT_MODELELEMENTREFERENCE_BY_NAME()
int getSORT_FOLDERREFERENCE_BY_NAME()
int getSORT_FOLDERREFERENCE_BY_FOLDER()
int getSORT_PLANREFERENCE_BY_NAME()
int getSORT_PLANREFERENCE_BY_PLAN()
int getSORT_STAKEHOLDERREFERENCE_BY_NAME()
int getSORT_STAKEHOLDERREFERENCE_BY_STAKEHOLDER()
int getSORT_ROLEREFERENCE_BY_NAME()
int getSORT_ROLEREFERENCE_BY_ROLE()
int getSORT_CROSSREFERENCE_BY_NAME()
java.util.List<? extends IFolder> getAllFolders()
java.util.List<? extends IFolder> getAllFolders(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IFolder> getAllFolders(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IFolder> getAllFoldersWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IFolder> getAllFoldersWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IFolder> getAllFoldersWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IFolder> getAllFoldersWithDefaultCategory()
java.util.List<? extends IFolder> getAllFoldersWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IFolder> getAllFoldersWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IFolder> getAllRootFolders()
java.util.List<? extends IFolder> getAllRootFolders(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IFolder> getAllRootFolders(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IFolder> getAllRootFoldersWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IFolder> getAllRootFoldersWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IFolder> getAllRootFoldersWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IFolder> getAllRootFoldersWithDefaultCategory()
java.util.List<? extends IFolder> getAllRootFoldersWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IFolder> getAllRootFoldersWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IFolder> getAllFoldersForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Note: For the purpose of this method, the current version of an folder is
only assigned to the history item for the commit of the last change of the
folder. This method does not allow to access old versions.
historyItem - history item identifying the last change of the folder itemsjava.util.List<? extends IContainer> getAllContainers()
java.util.List<? extends IContainer> getAllContainers(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IContainer> getAllContainers(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IContainer> getAllContainersWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IContainer> getAllContainersWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IContainer> getAllContainersWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IContainer> getAllContainersWithDefaultCategory()
java.util.List<? extends IContainer> getAllContainersWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IContainer> getAllContainersWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingboolean hasContainersForModelElement(java.lang.String modelElementUID)
modelElementUID - unique identifier of the model elementjava.util.List<? extends IContainer> getAllContainersForModelElement(java.lang.String modelElementUID)
modelElementUID - the uid of the model elementjava.util.List<? extends IContainer> getAllContainersForModelElement(java.lang.String modelElementUID, int sortingCriterion)
modelElementUID - the uid of the model elementsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IContainer> getAllContainersForModelElement(java.lang.String modelElementUID, java.lang.String sortingProperty)
modelElementUID - the uid of the model elementsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IContainer> getAllContainersNotLinkedToAnyModelElement()
java.util.List<? extends IContainer> getAllContainersNotLinkedToAnyModelElement(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IContainer> getAllContainersNotLinkedToAnyModelElement(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IContainer> getAllContainersForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Note: For the purpose of this method, the current version of an container is
only assigned to the history item for the commit of the last change of the
container. This method does not allow to access old versions.
historyItem - history item identifying the last change of the container itemsjava.util.List<? extends IText> getAllTexts()
java.util.List<? extends IText> getAllTexts(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IText> getAllTexts(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IText> getAllTextsWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IText> getAllTextsWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IText> getAllTextsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IText> getAllTextsWithDefaultCategory()
java.util.List<? extends IText> getAllTextsWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IText> getAllTextsWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IText> getAllTextsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Note: For the purpose of this method, the current version of an text is
only assigned to the history item for the commit of the last change of the
text. This method does not allow to access old versions.
historyItem - history item identifying the last change of the text itemsjava.util.List<? extends ITextReference> getAllTextReferences()
java.util.List<? extends ITextReference> getAllTextReferences(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends ITextReference> getAllTextReferences(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends ITextReference> getAllTextReferencesWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends ITextReference> getAllTextReferencesWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends ITextReference> getAllTextReferencesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends ITextReference> getAllTextReferencesWithDefaultCategory()
java.util.List<? extends ITextReference> getAllTextReferencesWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends ITextReference> getAllTextReferencesWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends ITextReference> getAllTextReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Note: For the purpose of this method, the current version of an text reference is
only assigned to the history item for the commit of the last change of the
text reference. This method does not allow to access old versions.
historyItem - history item identifying the last change of the text reference itemsjava.util.List<? extends IPicture> getAllPictures()
java.util.List<? extends IPicture> getAllPictures(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPicture> getAllPictures(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPicture> getAllPicturesWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IPicture> getAllPicturesWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPicture> getAllPicturesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPicture> getAllPicturesWithDefaultCategory()
java.util.List<? extends IPicture> getAllPicturesWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPicture> getAllPicturesWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPicture> getAllPicturesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Note: For the purpose of this method, the current version of an picture is
only assigned to the history item for the commit of the last change of the
picture. This method does not allow to access old versions.
historyItem - history item identifying the last change of the picture itemsjava.util.List<? extends IPictureReference> getAllPictureReferences()
java.util.List<? extends IPictureReference> getAllPictureReferences(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPictureReference> getAllPictureReferences(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPictureReference> getAllPictureReferencesWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IPictureReference> getAllPictureReferencesWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPictureReference> getAllPictureReferencesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPictureReference> getAllPictureReferencesWithDefaultCategory()
java.util.List<? extends IPictureReference> getAllPictureReferencesWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPictureReference> getAllPictureReferencesWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPictureReference> getAllPictureReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Note: For the purpose of this method, the current version of an picture reference is
only assigned to the history item for the commit of the last change of the
picture reference. This method does not allow to access old versions.
historyItem - history item identifying the last change of the picture reference itemsjava.util.List<? extends IModelElementReference> getAllModelElementReferences()
java.util.List<? extends IModelElementReference> getAllModelElementReferences(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IModelElementReference> getAllModelElementReferences(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IModelElementReference> getAllModelElementReferencesWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IModelElementReference> getAllModelElementReferencesWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IModelElementReference> getAllModelElementReferencesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IModelElementReference> getAllModelElementReferencesWithDefaultCategory()
java.util.List<? extends IModelElementReference> getAllModelElementReferencesWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IModelElementReference> getAllModelElementReferencesWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingboolean hasModelElementReferencesForModelElement(java.lang.String modelElementUID)
modelElementUID - unique identifier of the model elementjava.util.List<? extends IModelElementReference> getAllModelElementReferencesForModelElement(java.lang.String modelElementUID)
modelElementUID - the uid of the model elementjava.util.List<? extends IModelElementReference> getAllModelElementReferencesForModelElement(java.lang.String modelElementUID, int sortingCriterion)
modelElementUID - the uid of the model elementsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IModelElementReference> getAllModelElementReferencesForModelElement(java.lang.String modelElementUID, java.lang.String sortingProperty)
modelElementUID - the uid of the model elementsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IModelElementReference> getAllModelElementReferencesNotLinkedToAnyModelElement()
java.util.List<? extends IModelElementReference> getAllModelElementReferencesNotLinkedToAnyModelElement(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IModelElementReference> getAllModelElementReferencesNotLinkedToAnyModelElement(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IModelElementReference> getAllModelElementReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Note: For the purpose of this method, the current version of an model element reference is
only assigned to the history item for the commit of the last change of the
model element reference. This method does not allow to access old versions.
historyItem - history item identifying the last change of the model element reference itemsjava.util.List<? extends IFolderReference> getAllFolderReferences()
java.util.List<? extends IFolderReference> getAllFolderReferences(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IFolderReference> getAllFolderReferences(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IFolderReference> getAllFolderReferencesWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IFolderReference> getAllFolderReferencesWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IFolderReference> getAllFolderReferencesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IFolderReference> getAllFolderReferencesWithDefaultCategory()
java.util.List<? extends IFolderReference> getAllFolderReferencesWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IFolderReference> getAllFolderReferencesWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IFolderReference> getAllFolderReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Note: For the purpose of this method, the current version of an folder reference is
only assigned to the history item for the commit of the last change of the
folder reference. This method does not allow to access old versions.
historyItem - history item identifying the last change of the folder reference itemsjava.util.List<? extends IPlanReference> getAllPlanReferences()
java.util.List<? extends IPlanReference> getAllPlanReferences(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPlanReference> getAllPlanReferences(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPlanReference> getAllPlanReferencesWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IPlanReference> getAllPlanReferencesWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPlanReference> getAllPlanReferencesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPlanReference> getAllPlanReferencesWithDefaultCategory()
java.util.List<? extends IPlanReference> getAllPlanReferencesWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPlanReference> getAllPlanReferencesWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPlanReference> getAllPlanReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Note: For the purpose of this method, the current version of an plan reference is
only assigned to the history item for the commit of the last change of the
plan reference. This method does not allow to access old versions.
historyItem - history item identifying the last change of the plan reference itemsjava.util.List<? extends IStakeholderReference> getAllStakeholderReferences()
java.util.List<? extends IStakeholderReference> getAllStakeholderReferences(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IStakeholderReference> getAllStakeholderReferences(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IStakeholderReference> getAllStakeholderReferencesWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IStakeholderReference> getAllStakeholderReferencesWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IStakeholderReference> getAllStakeholderReferencesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IStakeholderReference> getAllStakeholderReferencesWithDefaultCategory()
java.util.List<? extends IStakeholderReference> getAllStakeholderReferencesWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IStakeholderReference> getAllStakeholderReferencesWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IStakeholderReference> getAllStakeholderReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Note: For the purpose of this method, the current version of an stakeholder reference is
only assigned to the history item for the commit of the last change of the
stakeholder reference. This method does not allow to access old versions.
historyItem - history item identifying the last change of the stakeholder reference itemsjava.util.List<? extends IRoleReference> getAllRoleReferences()
java.util.List<? extends IRoleReference> getAllRoleReferences(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IRoleReference> getAllRoleReferences(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IRoleReference> getAllRoleReferencesWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IRoleReference> getAllRoleReferencesWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IRoleReference> getAllRoleReferencesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IRoleReference> getAllRoleReferencesWithDefaultCategory()
java.util.List<? extends IRoleReference> getAllRoleReferencesWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IRoleReference> getAllRoleReferencesWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IRoleReference> getAllRoleReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Note: For the purpose of this method, the current version of an role reference is
only assigned to the history item for the commit of the last change of the
role reference. This method does not allow to access old versions.
historyItem - history item identifying the last change of the role reference itemsjava.util.List<? extends ICrossReference> getAllCrossReferences()
java.util.List<? extends ICrossReference> getAllCrossReferences(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends ICrossReference> getAllCrossReferences(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends ICrossReference> getAllCrossReferencesWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends ICrossReference> getAllCrossReferencesWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends ICrossReference> getAllCrossReferencesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends ICrossReference> getAllCrossReferencesWithDefaultCategory()
java.util.List<? extends ICrossReference> getAllCrossReferencesWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends ICrossReference> getAllCrossReferencesWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends ICrossReference> getAllCrossReferencesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
Note: For the purpose of this method, the current version of an cross reference is
only assigned to the history item for the commit of the last change of the
cross reference. This method does not allow to access old versions.
historyItem - history item identifying the last change of the cross reference itemsIFolder findFolder(java.lang.String path)
path - the path