com.arcway.cockpit.documentmodule.docgen.provider.interfaces

Interface IDocumentContainer

All Superinterfaces:

com.arcway.cockpit.docgen.provider.interfaces.ICockpitData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

public interface IDocumentContainer
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

The IDocumentContainer object allows to read attribute values of a document container from the COCKPIT document module. Starting with this object, you can get references to contained resource locators.

Item type constant: "dcm.documentContainer"

Method Summary

Modifier and Type	Method and Description
boolean	containsResourceLocators() Checks whether the document container contains any resource locators.
java.lang.String	getDocumentContainerSet() Returns the name of the document container set of the container.
IDocumentContainerSet	getDocumentContainerSetInterface() Returns the document container set of the container.
java.util.List<? extends IResourceLocator>	getFileLinks() Returns all contained file links.
java.util.List<? extends IResourceLocator>	getFileLinksWithCategory(java.lang.String categoryID) Returns all contained file links that belong to the specified category.
java.util.List<? extends IResourceLocator>	getFileLinksWithDefaultCategory() Returns all contained file links that belong to the default category.
java.lang.String	getKeywords() Returns the keywords.
java.lang.String	getName() Returns the name.
java.util.List<? extends IResourceLocator>	getResourceLocators() Returns all contained resource locators.
java.lang.String	getStatus() Returns the status.
java.lang.String	getUniqueIdentifier() Returns a unique identifier that uniquely identifies this object within its project.
java.util.List<? extends IResourceLocator>	getWebLinks() Returns all contained web links.
java.util.List<? extends IResourceLocator>	getWebLinksWithCategory(java.lang.String categoryID) Returns all contained web links that belong to the specified category.
java.util.List<? extends IResourceLocator>	getWebLinksWithDefaultCategory() Returns all contained web links that belong to the default category.
com.arcway.cockpit.docgen.provider.interfaces.IRecord	toRecord() Converts this generic module data into a record.

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

getCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFileProperty

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

getCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

Method Detail

getUniqueIdentifier

java.lang.String getUniqueIdentifier()

Returns a unique identifier that uniquely identifies this object within its project.

Specified by:

getUniqueIdentifier in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

Returns:

the unique identifier

getName

java.lang.String getName()

Returns the name.

Returns:

the name

getKeywords

java.lang.String getKeywords()

Returns the keywords.

Returns:

the keywords

getStatus

java.lang.String getStatus()

Returns the status.

Returns:

the status

containsResourceLocators

boolean containsResourceLocators()

Checks whether the document container contains any resource locators.

Returns:

true, if resource locators exist, false otherwise

getResourceLocators

java.util.List<? extends IResourceLocator> getResourceLocators()

Returns all contained resource locators.

The resource locators are sorted by URL.

Returns:

array of IResourceLocator

getDocumentContainerSet

java.lang.String getDocumentContainerSet()

Returns the name of the document container set of the container.

Returns:

the name of the document container set

getDocumentContainerSetInterface

IDocumentContainerSet getDocumentContainerSetInterface()

Returns the document container set of the container.

Returns:

the document container set

getWebLinks

java.util.List<? extends IResourceLocator> getWebLinks()

Returns all contained web links.

Returns:

array of IResourceLocator

getFileLinks

java.util.List<? extends IResourceLocator> getFileLinks()

Returns all contained file links.

Returns:

array of IResourceLocator

getWebLinksWithCategory

java.util.List<? extends IResourceLocator> getWebLinksWithCategory(java.lang.String categoryID)

Returns all contained web links that belong to the specified category.

Returns:

array of IResourceLocator

getFileLinksWithCategory

java.util.List<? extends IResourceLocator> getFileLinksWithCategory(java.lang.String categoryID)

Returns all contained file links that belong to the specified category.

Returns:

array of IResourceLocator

getWebLinksWithDefaultCategory

java.util.List<? extends IResourceLocator> getWebLinksWithDefaultCategory()

Returns all contained web links that belong to the default category.

Returns:

array of IResourceLocator

getFileLinksWithDefaultCategory

java.util.List<? extends IResourceLocator> getFileLinksWithDefaultCategory()

Returns all contained file links that belong to the default category.

Returns:

array of IResourceLocator

toRecord

com.arcway.cockpit.docgen.provider.interfaces.IRecord toRecord()

Converts this generic module data into a record.

In addition to all fields documented at ICustomPropertiesAccess.toRecord(), in the created record, the following fields are filled accoring to the wrapped cockpit data:

• IRecord.NAME_KEY

Specified by:

toRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

Specified by:

toRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

Returns:

converted cockpit project data