Skip navigation links
A C D E F G H I L M N O P R S T U V W 

G

generateUID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProjectDataProvider
Generates a UID.
get(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Returns the child object stored under the given key.
get(String, int) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Returns a child object stored under the given key with a given index.
getAddress() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholder
Returns the address of the stakeholder.
getAll(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Returns all child object stored under the given key.
getAllFolders() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Returns all folders and subfolders for this plan starting at the root.
getAllFoldersForHistoryItem(IHistoryEntry) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all folders which have been modified the last time with the commit identified by the history item.
getAllLocksOnServer() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredServerConnection
Returns all locks set on the server.
getAllModelElements() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Returns all model elements on this plan sorted by their type and element names.
getAllModelElements() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all model elements of the selected project sorted by their type and element names

getAllModelElements(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all model elements of the selected project of the specified type sorted by their element names.
getAllModelElementsForHistoryItem(IHistoryEntry) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all model elements which have been modified the last time with the commit identified by the history item.
getAllModelElementsWithCategory(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all model elements of this project that belong to the specified category sorted by their type and element names.
getAllModelElementsWithCategory(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all model elements of this project of the specified type that belong to the specified category sorted by their type and element names.
getAllModelElementsWithDefaultCategory() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all model elements of this project that belong to the default category sorted by their type and element names.
getAllModelElementsWithDefaultCategory(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all model elements of this project of the specified type that belong to the default category sorted by their type and element names.
getAllowedValuesOfCustomProperty(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDataModelProvider
Returns the value range of the data type of the specified custom property of the specified object type.
getAllPlans() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all construction plans of the selected project sorted by their plan names

getAllPlansForHistoryItem(IHistoryEntry) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all plans which have been modified the last time with the commit identified by the history item.
getAllPlansInDefinedOrder() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all construction plans of the selected project in the order they occur in the project

getAllPlansOfSubTree() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns all plans of the folder and all sub folders.
getAllPlansOfSubTreeWithCategory(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns all plans of the folder and all sub folders that belong to the specified category.
getAllPlansOfSubTreeWithDefaultCategory() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns all plans of the folder and all sub folders that belong to the default category.
getAllStakeholderRoles() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all stakeholder roles of this project.
getAllStakeholderRolesForHistoryItem(IHistoryEntry) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all Stakeholder Roles which have been modified the last time with the commit identified by the history item.
getAllStakeholderRolesWithCategory(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all stakeholder roles of this project that belong to the specified category.
getAllStakeholderRolesWithDefaultCategory() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all stakeholder roles of this project that belong to the default category.
getAllStakeholders() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all stakeholders of this project.
getAllStakeholdersForHistoryItem(IHistoryEntry) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all Stakeholders which have been modified the last time with the commit identified by the history item.
getAllStakeholdersWithCategory(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all stakeholders of this project that belong to the specified category.
getAllStakeholdersWithDefaultCategory() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all stakeholders of this project that belong to the default category.
getAngle() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Returns the angle.
getAngleInDegrees() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRequestFlowInfo
Gets the angle of the request symbol.
getArraySize(Object[]) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IArrayHelper
Deprecated.
use Collection.size()
getArraySize(String[]) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IArrayHelper
Deprecated.
use Collection.size()
getArraySize(List<Object>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IArrayHelper
Deprecated.
use Collection.size()
getAspectID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
 
getAttribute(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Equivalent to IRecord.get(String) for attributeID.
getAttribute_asParagraphList(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Equivalent to IRecord.getAll(String) for attributeID.
getAttribute_asSingleLine(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Equivalent to IRecord.get(String) for attributeID.
getAttribute_asTimestamp_MilliSecondsSince_01_01_1970(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Interpretes IRecord.get(String) for attributeID as a decimal string and returns a corresponding Long object.
getAttributeIDForReplacedPlanElementComment() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Returns the property id for comment replacement.
getAttributeIDForReplacedPlanElementDescription() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Returns the property id for description replacement.
getAttributeIDForReplacedPlanElementName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Returns the property id for name replacement.
getBlue() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IColor
Gets the blue value.
getCachedRecord(Map<String, IRecord>, ICockpitData) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IArrayHelper
Converts a cockpit project data into a record.
getCachedRecordCrossProject(Map<String, Map<String, IRecord>>, ICockpitData, Set<String>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IArrayHelper
Converts a cockpit project data into a record.
getCachedRecords(Map<String, IRecord>, Collection<ICockpitData>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IArrayHelper
Converts cockpit project data into records.
getCachedRecordsCrossProject(Map<String, Map<String, IRecord>>, Collection<ICockpitData>, Set<String>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IArrayHelper
Converts cockpit project data into records.
getCategoryID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
Returns the ID of the category that the object belongs to.
getCategoryID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getCategoryIDsForObjectType(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDataModelProvider
Returns the ids of all categories of an object type.
getCategoryLabel() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
Returns the label of the category that the object belongs to.
getCategoryLabel() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getCausallyDirectlyPrecedingModelElements() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which are causally directly preceeding this model element.
getCausallyDirectlyPrecedingModelElementsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which are causally directly preceeding this model element on the specified plan.
getCausallyDirectlySucceedingModelElements() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which are causally directly preceded by this model element.
getCausallyDirectlySucceedingModelElementsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which are causally directly preceded by this model element on the specified plan.
getCausallyPrecedingModelElements() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which are causally preceding this model element.
getCausallyPrecedingModelElementsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which are causally preceding this model element on the specified plan.
getCausallySucceedingModelElements() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which are causally preceded by this model element.
getCausallySucceedingModelElementsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which are causally preceded by this model element on the specified plan.
getChild(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFileHelper
Creates a filename from a parent pathname string and a child pathname string.
getClientName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ILockOnServer
Returns the name of the client that created the lock.
getColorWeight() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IElementPresentationRule
Determines "how much" the color effect is applied.
getComment() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IElementPresentationRule
Gets the comment for this element
getComment() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry
Returns the commit comment of the change.
getCommitVersion() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns the version ID of the commit when the object has been changed teh last time.
getCommitVersion() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getCommunicatingFunctions() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all communicating functions, i.e. functions which are connected via transitive reading AND writing accesses.
getCommunicatingFunctionsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all communicating functions on the specified plan, i.e.
getCompany() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholder
Returns the name of the stakeholders company.
getConfiguredProjects() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredServerConnection
Returns all currently configured projects of this server.
getConfiguredProjects() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRootDataProvider
Returns all currently configured projects.
getConfiguredServerConnections() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRootDataProvider
Returns all currently configured server connections.
getContainedModelElements() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which are contained directly or indirectly in this model element.
getContainedModelElementsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which are contained directly or indirectly in this model element on the specified plan.
getContainedPlanElements() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
Gets a collection of all plan elements that are contained by this plan element.
getContainerModelElements() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which directly or indirectly contain this model element.
getContainerModelElementsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which directly or indirectly contain this model element on the specified plan.
getContainers() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
Gets a collection of all plan elements that contain this plan element.
getCopy() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IElementPresentationRule
Gets a copy of this rule.
getCoronaColor() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IElementPresentationRule
Gets the corona color.
getCoronaWidth() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IElementPresentationRule
Gets the corona width.
getCreationDate() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns the creation date.
getCreationDate() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Interpretes IRecord.get(String) for key IRecord.CREATION_DATE_KEY as a decimal string that represents milliseconds from 1970-01-01 and returns a corresponding HTML encoded date string.
getCreationDate_MilliSecondsSince_01_01_1970() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns the date of the creation date in milli senconds since 01/01/1970.
getCreationDate_MilliSecondsSince_01_01_1970() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Interpretes IRecord.get(String) for key IRecord.CREATION_DATE_KEY as a decimal string and returns a corresponding Long object.
getCreationTime() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ILockOnServer
Returns the creation time of the lock.
getCreator() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns the creator's name.
getCreator() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getCSVLine(Object[], String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICSVHelper
Builds a text line in comma separated values format where each of the given attributes are separated by the given separator string.
getCSVLine(Collection<Object>, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICSVHelper
Builds a text line in comma separated values format where each of the given attributes are separated by the given separator string.
getCSVStringForAttribute(Object) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICSVHelper
Converts the HTML encoded string of an attribute into one string which can be used as element in an CSV file.
getCSVStringForString(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICSVHelper
Converts a string into one string which can be used as element in an CSV file.
getCurrentDate() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDateTimeProvider
Returns the current date as string.
getCurrentDateTime() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDateTimeProvider
Returns the current date and time as string.
getCurrentDateTime_MilliSecondsSince_01_01_1970() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDateTimeProvider
getCurrentDateTime_MilliSecondsSince_01_01_1970 Returns the current date and time messured in milli seconds since 01/01/1970.
getCurrentTime() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDateTimeProvider
Returns the current time as string.
getCustomPropertiesForObjectTypeCategory(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDataModelProvider
Returns the ids of all custom properties of the specified object type that are visible for the specified category.
getCustomPropertyIdsForObjectType(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDataModelProvider
Returns a list with the IDs of all custom properties of the specified object type.
getDatatypeDisplaynameOfProperty(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDataModelProvider
Returns the display name of the data type of the specified custom property of the specified object type.
getDatatypeIDOfProperty(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDataModelProvider
Returns the data type id of the specified custom property of the specified object type.
getDate() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry
Returns the date of the commit change.
getDateOfLastModification() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns the date of the last modification.
getDateOfLastModification() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Interpretes IRecord.get(String) for key IRecord.DATE_OF_LAST_MODIFICATON_KEY as a decimal string that represents milliseconds from 1970-01-01 and returns a corresponding HTML encoded date string.
getDateOfLastModification_MilliSecondsSince_01_01_1970() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns the date of the last modification in milli senconds since 01/01/1970.
getDateOfLastModification_MilliSecondsSince_01_01_1970() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Interpretes IRecord.get(String) for key IRecord.DATE_OF_LAST_MODIFICATON_KEY as a decimal string and returns a corresponding Long object.
getDateTimeProperty_MilliSecondsSince_01_01_1970(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
Returns the date time in millisenconds since 1st January 1970.
getDateTimeProperty_MilliSecondsSince_01_01_1970(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Interpretes IRecord.get(String) for propertyID as a decimal string and returns a corresponding Long object.
getDescription() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IElementPresentationRule
Gets the description for this element
getDescription() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the description of the folder.
getDescription() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns the description of the unique element as list of Strings.
getDescription() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Returns the description of the plan/diagram.
getDescription() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns the description of the project.
getDescription() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getDescription() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IServerGroup
 
getDescription() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IServerUser
 
getDescription() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholder
Returns the description text of the stakeholder.
getDescription() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholderRole
Returns the description text of the stakeholder.
getDirectContainerModelElements() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which directly contain this model element.
getDirectContainerModelElementsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which directly contain this model element on the specified plan.
getDirectlyContainedModelElements() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which are contained directly in this model element.
getDirectlyContainedModelElementsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all model elements which are contained directly in this model element on the specified plan.
getDisplayName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns the display name of the item, i.e. a label representing the item.
getDisplayName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IElementPresentationRule
Gets the display name for this element
getDisplayName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getDisplayName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IServerGroup
 
getDisplayName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IServerUser
 
getDisplaynameOfCategory(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDataModelProvider
Returns the display name of a category.
getDisplaynameOfProperty(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDataModelProvider
Returns the displayname of the specified custom property of the specified object type.
getElementPresentationRules() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Returns the element presentation rules.
getElementTypeID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns the id of the type of this unique element.
getElementTypeName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns the name of the type of this unique element.
getEMail() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IServerUser
 
getEmail() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholder
Returns the stakeholders email address.
getEMFFile() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic
Creates a emf+ version of the plan, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getEMFFileWithPresentationRule(IPlanPresentationRule) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a emf+ version of the plan with a configurable appearance, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getFax() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholder
Returns the stakeholders fax number.
getFileExtension(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFileHelper
Extracts the file extension from the given file name.
getFileNameWithoutPath(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFileHelper
Returns the name of the file or directory denoted by an abstract pathname.
getFileProperty(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
Returns a XML DocBook representation to access the file attribute.
getFileProperty(String, double, double) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
Returns a XML DocBook representation to access the file attribute.
getFileProperty(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Returns a XML DocBook representation to access the file attribute.
getFileProperty(String, double, double) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Returns a XML DocBook representation to access the file attribute.
getFilePropertyAsBase64StringList(String, boolean) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
Returns the content of a file as string list (Base64 encoded).
getFilePropertyAsBase64StringList(String, boolean) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Equivalent to IRecord.getAll(String) for attributeID.
getFilePropertyAsFileName(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
Returns the local file name for a file attribute.
getFilePropertyAsFileName(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
Returns the local file name for a file attribute.
getFilePropertyAsFileName(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Returns the local file name for a file attribute.
getFilePropertyAsFileName(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Returns the local file name for a file attribute.
getFilePropertyAsRawStringList(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
Returns the content of a file as string list.
getFilePropertyAsRawStringList(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Calls IRecord.getAll(String), performs a base64 decoding and splits the result into text lines.
getFilePropertyAsStringList(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
Returns the content of a file as string list (html encoded).
getFilePropertyAsStringList(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Calls IRecord.getAll(String), performs a base64 decoding, splits the result into text lines and html encodes the text lines.
getFillColor() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IElementPresentationRule
Gets the fill color.
getFillOpacity() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IElementPresentationRule
Determines, how much the element should become transparent or opaque Default value is: 0 (keep original value).
getFolder() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Returns the folder where this plan can be found.
getFontName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ITextStyle
Font name.
getGreen() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IColor
Gets the green value.
getGroupName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IServerGroup
 
getGroupNames() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IServerUser
 
getGroups() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredServerConnection
Returns all groups available on this server.
getH() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRectangle
 
getHeightInMM() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Gets the height in MM
getHinMM() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IImageInfo
 
getHinMM() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanInfo
 
getHinPixels() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IImageInfo
 
getHRef() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ILink
returns the href attribute of the link as string

getIconOfCategory(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IDataModelProvider
Returns the icon of a category.
getID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Equivalent to IRecord.get(String) for key IRecord.ID_KEY.
getImage() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic
Creates an image version of the plan in the file format preffered by the selected document output format (e.g. word: wmf, HTML: png, DocBOOK: svg), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getImage(Map<String, ILink>, Map<String, IElementPresentationRule>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Deprecated.
getImage(boolean, boolean) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates an image version of the plan with meta information (e.g.
getImageFileWithMetaInformation() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates an image version of the plan with meta information (e.g.
getImageFileWithMetaInformation(Map<String, ILink>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Deprecated.
getImageFileWithMetaInformation(Map<String, ILink>, Map<String, IElementPresentationRule>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Deprecated.
getImageFileWithReplacedPlanElementName(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a image version of the plan.
getImageFileWithReplacedPlanElementName(String, Map<String, ILink>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Deprecated.
getImageFileWithReplacedPlanElementName(String, Map<String, ILink>, Map<String, IElementPresentationRule>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Deprecated.
getImageInfo(IPlanPresentationRule) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Returns information about a plan corresponding to IPlan.getImageWithPresentationRule(IPlanPresentationRule).
getImageWithPresentationRule(IPlanPresentationRule) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates an image version of the plan with a configurable appearance in the file format preferred by the selected document output format (e.g. word: wmf, HTML: png, DocBOOK: svg), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getIndividualVersionName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Gets the individual name for the plan version (by default determined by the plan's history)
getInfluencedInfos() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all influenced infos, i.e. infos which are connected via transitive writing accesses.
getInfluencedInfosOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all influenced infos on the specified plan, i.e. infos which are connected via transitive writing accesses.
getInfluencingInfos() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all influencing infos, i.e. infos which are connected via transitive reading accesses.
getInfluencingInfosOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all influencing infos on the specified plan, i.e. infos which are connected via transitive reading accesses.
getKeySet() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Determines all keys in order they were added.
getLabelForUID(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns a label for the object with the specified unique identifier.
getLanguage() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns the language of the project.
getLastModifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns the last modifier's name.
getLastModifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getLeafModelElementsOfCausalityRelationship() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Returns all model elements on this plan, which are leaf elements of the causality relationship, i.e. which are not causally preceding any other model element.
getLeafModelElementsOfCausalityRelationship() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all model elements of the selected project, which are leaf elements of the causality relationship, i.e. which are not causally preceding any other model element.
getLeafModelElementsOfContainmentRelationship() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Returns all model elements on this plan, which are leaf elements of the containment relationship, i.e. which do not contain any other model element.
getLeafModelElementsOfContainmentRelationship() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all model elements of the selected project, which are leaf elements of the containment relationship, i.e. which do not contain any other model element.
getLineColor() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IElementPresentationRule
Gets the line color.
getLinkForShow() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Creates a link to show an object in ARCWAY COCKPIT.
getLinkForShow(IPlanPresentationRule) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a link to show this plan in ARCWAY COCKPIT.
getLinkMap() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Returns the linkmap.
getLockedItemType() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ILockOnServer
Returns the type of the locked item.
getLockedItemUID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ILockOnServer
Returns the UID of the locked item.
getLockTypeID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ILockOnServer
Returns the ID of the lock type.
getLogo() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns a XML DocBook representation to access the project logo.
getModelElementTypes() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProjectDataProvider
Returns a list of description elements for the supported model element types.
getModelElementUID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
 
getModificationCount() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns the modification count (i.e. the number of times the item has been changed so far).
getModificationCount() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getModifiedInfos() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all modified infos.
getModifiedInfosOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all modified infos on the specified plan.
getModifyingFunctions() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all modifying functions.
getModifyingFunctionsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all modifying functions on the specified plan.
getName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the name of the folder.
getName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns the name of the unique element.
getName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElementTypeDescription
Returns the name of the unique element type.
getName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Returns the name of the plan.
getName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns the name of the COCKPIT project.
getName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Equivalent to IRecord.get(String) for key IRecord.NAME_KEY.
getName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholder
Returns the name of the stakeholder.
getName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholderRole
Returns the name of the stakeholder.
getNameInPlural() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElementTypeDescription
Returns the plural name for unique elements of this type.
getNrOfEntries(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Gets the number of child objects stored under the given key.
getNumberOfTextLines(String, ITextStyle, double, double) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IGraphicsHelper
Gets the needed number of text lines.
getObjectType() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Equivalent to IRecord.getKeySet() contains strings starting with IRecord.OBJECT_TYPE_KEY}

getOccurrences() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all plans on which the current unique element is displayed.
getOffsetXinMM() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Gets the offset if explicitly set. (0 if not set)
getOffsetYinMM() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Gets the offset if explicitly set. (0 if not set)
getOperandType() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPermission
The operand type describes the operand on which the operation is permitted by this permission.
getOperandUID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPermission
The UID of the operand on which the operation is permitted by this permission.
getOperation() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPermission
Describes the operation which is permissted by this permission.
getOperation2() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPermission
get the additional operation part
getOuterBoundsInMM() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
Returns the outer bounds of this plan element in MM.
getOuterBoundsInMM() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanInfo
 
getOwnerID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPermission
Returns the ID of the owner (the user or the group)

getOwnerType() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPermission
Returns the type of the owner ( user or group)

getParent(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFileHelper
Returns the pathname string of the parent, or null if the pathname does not name a parent directory.
getParent() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the parent folder of the current folder.
getPermissionUID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPermission
Returns the UID of the permission.
getPhone() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholder
Returns the stakeholders phone number.
getPlanElementDescription() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
 
getPlanElementInfos() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanInfo
 
getPlanElementInfosSortedByStructure() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanInfo
 
getPlanElementName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
 
getPlanElementTypeID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
 
getPlanElementUID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
 
getPlans() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the plans of this folder.
getPlansSortedBy(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns all plans sorted by the specified property.
getPlansWithCategory(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the plans of this folder that belong to the specified category.
getPlansWithCategorySortedBy(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns all plans that belong to the specified category sorted by the specified property.
getPlansWithDefaultCategory() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the plans of this folder that belong to the default category.
getPlansWithDefaultCategorySortedBy(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns all plans that belong to the default category sorted by the specified property.
getPlanType() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Returns the internal type name of the plan.
getPNGFile() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic
Creates a png version of the plan, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getPNGFile(boolean, boolean) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a png version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getPNGFileWithMetaInformation() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a png version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getPNGFileWithPresentationRule(IPlanPresentationRule) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a png version of the plan with a configurable appearance, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getPNGFileWithReplacedPlanElementName(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a png version of the plan.
getPointUnionInMM() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
Returns the union of all points of this plan element in MM.
getPredecessors() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
Gets a collection of all plan elements that precedes this plan element.
getProject() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProjectDataProvider
Returns the project root node.
getProjectDumpAsFileName(String, int) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProjectOnServer
Retrieves a project dump file from the server and returns the local file name.
getProjectHistoryEntries() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all entries of the project's history.
getProjection() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IElementPresentationRule
Returns the projecton of this plan element
getProjectionAreaInMM() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
Returns the projection area of this plan element.
getProjectName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredProject
Returns the name of the project.
getProjectName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProjectOnServer
Returns a string representation of the project's name.
getProjectPermissions() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredProject
Returns all server permissions related to this project.
getProjectRelatedReportDataProviders() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredProject
Returns all data providers of this project.
getProjectRelatedReportDataProvidersWithoutFilter() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredProject
Returns all data providers of this project.
getProjectsOnServer() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredServerConnection
Returns all projects stored on this server that are visible for the current user.
getProjectUID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredProject
Returns the project's UID.
getProjectUID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ILockOnServer
Returns the UID of the project this lock belongs to.
getProjectUID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProjectOnServer
Returns the project UID.
getProjectUniqueIdentifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns a unique identifier that uniquely identifies the COCKPIT project that contains this object.
getProjectUniqueIdentifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getPropertyAsString(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
Returns a string representation of the property value.
getPropertyAsString(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Concatenates alls String returned by IRecord.getAll(String) for propertyID, separting the strings by a space character.
getPropertyAsStringArray(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
getPropertyAsStringArray(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getPropertyAsStringList(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
Returns a list of strings representing the property value.
getPropertyAsStringList(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Equivalent to IRecord.getAll(String) for propertyID.
getReaders() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
Gets a collection of all plan elements that read this plan element.
getReadInfos() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all read infos.
getReadInfosOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all read infos on the specified plan.
getReadingFunctions() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all reading functions.
getReadingFunctionsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all reading functions on the specified plan.
getReceivingFunctions() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all receiving functions, i.e. functions which are connected via transitive writing accesses.
getReceivingFunctionsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all receiving functions on the specified plan, i.e. functions which are connected via transitive writing accesses.
getRed() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IColor
Gets the red value.
getRelatedInfos() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all related infos, i.e. infos which are connected via transitive reading AND writing accesses.
getRelatedInfosOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all related infos on the specified plan, i.e. infos which are connected via transitive reading AND writing accesses.
getRequestFlowInfos() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
Returns information about all request flow symbols of this plan element.
getRole() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IElementPresentationRule
Gets the role name for this element The role e.g. is used in SVG graphics as classID.
getRole() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Gets the role name for this plan The role e.g. is used in SVG graphics as classID.
getRole() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRequestFlowInfo
Gets the role of this request symbol.
getRole() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ITextInfo
Gets the role of this text.
getRoles() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholder
Returns all roles of this stakeholder within the current project.
getRootFolders() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns the root folders of the project.
getRootFoldersWithCategory(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns the root folders of the project that belong to the specified category.
getRootFoldersWithDefaultCategory() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns the root folders of the project that belong to the default category.
getRootModelElementsOfCausalityRelationship() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Returns all model elements on this plan, which are root elements of the causality relationship, i.e. for which no causally preceding model element exists.
getRootModelElementsOfCausalityRelationship() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all model elements of the selected project, which are root elements of the causality relationship, i.e. for which no causally preceding model element exists.
getRootModelElementsOfContainmentRelationship() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Returns all model elements on this plan, which are root elements of the containment relationship, i.e. which are not contained in any other model element.
getRootModelElementsOfContainmentRelationship() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns all model elements of the selected project, which are root elements of the containment relationship, i.e. which are not contained in any other model element.
getRootPlans() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns the root plans of the project.
getSendingFunctions() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all sending functions, i.e. functions which are connected via transitive reading accesses.
getSendingFunctionsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all sending functions on the specified plan, i.e. functions which are connected via transitive reading accesses.
getServerConnection() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredProject
Returns the related server connection of this project.
getServerConnection() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProjectOnServer
Returns the server connection to the server on which this project is stored.
getServerDumpAsFileName(String, Collection<? extends String>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredServerConnection
Retrieves a server dump file from the server and returns the local file name.
getServerID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredServerConnection
 
getServerName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredServerConnection
 
getServerPermissions() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IServerGroup
 
getServerPermissions() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IServerUser
 
getServerURL() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredServerConnection
 
getShow() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ILink
returns the show attribute of the link as String, if used for svg export, "new" opens a new browser window, "replace" shows the link target in the same browser window, attention: with Adobe SVG Viewer 3.02 and Internet Explorer 6.0 "new" did not work
getStakeholderForCurrentUser() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns the stakeholder of the current user.
getStakeholderRole(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns the stakeholder role with the given name.
getStakeholders() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholderRole
Returns all stakeholders sorted by the name which have this role.
getStakeholdersWithCategory(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholderRole
Returns all stakeholders sorted by the name which have this role and that belong to the specified category.
getStakeholdersWithDefaultCategory() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholderRole
Returns all stakeholders sorted by the name which have this role and that belong to the default category.
getStringForAttribute(Object) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICSVHelper
Converts the HTML encoded string of an attribute into one string.
getStyleSheetFilename() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Gets the style sheet filename.
getSubFolder(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the sub folder with the specified name.
getSubFolders() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the sub folders of this folder.
getSubFolders(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the sub folders of this folder.
getSubFoldersWithCategory(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the sub folders of the this folder that belong to the specified category.
getSubFoldersWithCategory(String, String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the sub folders of the this folder that belong to the specified category.
getSubFoldersWithDefaultCategory() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the sub folders of the this folder that belong to the default category.
getSubFoldersWithDefaultCategory(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns the sub folders of the this folder that belong to the default category.
getSubSetType() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPermission
Returns the type of permission sub set this permission belongs to.
getSubSetUID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPermission
Returns the UID of a sub set.
getSuccessors() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
Gets a collection of all plan elements that succeeds this plan element.
getSVGFile() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic
Creates a svg version of the plan, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getSVGFile(Map<String, ILink>, Map<String, IElementPresentationRule>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Deprecated.
getSVGFile(boolean, boolean) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a svg version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getSVGFileWithMetaInformation() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a svg version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getSVGFileWithMetaInformation(Map<String, ILink>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Deprecated.
getSVGFileWithMetaInformation(Map<String, ILink>, Map<String, IElementPresentationRule>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Deprecated.
getSVGFileWithPresentationRule(IPlanPresentationRule) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a svg version of the plan with a configurable appearance, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getSVGFileWithReplacedPlanElementName(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a svg version of the plan.
getSVGFileWithReplacedPlanElementName(String, Map<String, ILink>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Deprecated.
getSVGFileWithReplacedPlanElementName(String, Map<String, ILink>, Map<String, IElementPresentationRule>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Deprecated.
getTarget() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ILink
returns the target attribute of the link as String, necessary for frame set, target defines the part of the frame set, the html page referenced by the link will be opened in
getText() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ITextInfo
Returns the text as list of Strings.
getTextInfos() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
Returns information about all texts of this plan element.
getTextLength(String, ITextStyle, double) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IGraphicsHelper
Gets the length of the given text.
getTextLineHeight() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ITextInfo
Gets the text line heigth of the text.
getTextReplacementConfiguration(Map<String, String>) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ITextManipulationHelper
Creates a text replacement configuration to be used with the method ITextManipulationHelper.executeReplacementInText(String, TextReplacementConfiguration) .
getTitle() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ILink
returns the title attribute of the link as String

getTitle() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
Equivalent to IRecord.get(String) for key IRecord.TITLE_KEY.
getTopologyType() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
Gives a hint how to sequantialize graphical elements: Where to proceed from this element?
getTypeID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns the id of the data type of the item.
getTypeID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElementTypeDescription
Returns an ID for this unique element type which is used internally to reference this type.
getTypeID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getTypeName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns the name of the data type of the item.
getTypeName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getUID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ILockOnServer
Returns the UID of the lock.
getUniqueIdentifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
getUniqueIdentifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IFolder
Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
getUniqueIdentifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry
Returns a unique identifier that uniquely identifies this history entry within the COCKPIT project.
getUniqueIdentifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
getUniqueIdentifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
getUniqueIdentifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IProject
Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
getUniqueIdentifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getUniqueIdentifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholder
Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
getUniqueIdentifier() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IStakeholderRole
Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
getUserDistinguishedName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredServerConnection
 
getUserDistinguishedName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry
Returns the distinguished name of the commiting user.
getUserLoginID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredServerConnection
 
getUserLoginID() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry
Returns the login ID of the commiting user.
getUserName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.ILockOnServer
Returns the name of the user that created the lock.
getUserName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IServerUser
 
getUserNames() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IServerGroup
 
getUserRealName() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredServerConnection
 
getUserRealname() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry
Returns the real name of the commiting user.
getUsers() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IConfiguredServerConnection
Returns all users available on this server.
getVersion() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry
Returns the version number of this entry.
getW() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRectangle
 
getWidthInMM() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Gets the width in MM
getWinMM() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IImageInfo
 
getWinMM() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanInfo
 
getWinPixels() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IImageInfo
 
getWMFFile() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic
Creates a wmf version of the plan, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getWMFFile(boolean, boolean) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a wmf version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getWMFFileWithMetaInformation() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a wmf version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getWMFFileWithPresentationRule(IPlanPresentationRule) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a wmf version of the plan with a configurable appearance, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
getWMFFileWithReplacedPlanElementName(String) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlan
Creates a wmf version of the plan.
getWrappedObject() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRecord
getWriters() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanElementInfo
Gets a collection of all plan elements that write this plan element.
getWritingFunctions() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all writing functions.
getWritingFunctionsOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all writing functions on the specified plan.
getWrittenInfos() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all written infos.
getWrittenInfosOnPlan(IPlan) - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IModelElement
Returns all written infos on the specified plan.
getX() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRectangle
 
getY() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IRectangle
 
getZoom() - Method in interface com.arcway.cockpit.docgen.provider.interfaces.IPlanPresentationRule
Gets the zoom if explicitly set.
A C D E F G H I L M N O P R S T U V W 
Skip navigation links