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

Interface IDocumentContainerSet

All Superinterfaces:

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

public interface IDocumentContainerSet
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

The IDocumentContainerSet object allows to read attribute values form a document container set from the COCKPIT document module.

Item type constant: "dcm.documentContainerSet"

Method Summary

Modifier and Type	Method and Description
boolean	containsDocumentContainers() Checks whether the docuement container set contains any document containers.
java.lang.String	getCategoryID()
java.util.List<? extends IDocumentContainer>	getDocumentContainers() Returns all contained document containers.
java.util.List<? extends IDocumentContainer>	getDocumentContainers(java.lang.String sortingProperty) Returns all contained document containers.
java.util.List<? extends IDocumentContainer>	getDocumentContainersWithCategory(java.lang.String categoryID) Returns all contained document containers that belong to the specified category.
java.util.List<? extends IDocumentContainer>	getDocumentContainersWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns all contained document containers that belong to the specified category.
java.util.List<? extends IDocumentContainer>	getDocumentContainersWithDefaultCategory() Returns all contained document containers that belong to the default category.
java.util.List<? extends IDocumentContainer>	getDocumentContainersWithDefaultCategory(java.lang.String sortingProperty) Returns all contained document containers that belong to the default category.
java.lang.String	getName() Returns the name.
java.lang.String	getUniqueIdentifier() Returns a unique identifier that uniquely identifies this object within its project.
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.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

containsDocumentContainers

boolean containsDocumentContainers()

Checks whether the docuement container set contains any document containers.

Returns:

true, if document containers exist, false otherwise

getDocumentContainers

java.util.List<? extends IDocumentContainer> getDocumentContainers()

Returns all contained document containers.

The document containers are sorted by natural order.

Returns:

array of IDocumentContainer

getDocumentContainers

java.util.List<? extends IDocumentContainer> getDocumentContainers(java.lang.String sortingProperty)

Returns all contained document containers.

Parameters:

sortingProperty - the custom property to use as a criterion for sorting

Returns:

array of IDocumentContainer

getDocumentContainersWithCategory

java.util.List<? extends IDocumentContainer> getDocumentContainersWithCategory(java.lang.String categoryID)

Returns all contained document containers that belong to the specified category.

The document containers are sorted by natural order.

Parameters:

categoryID - the category ID

Returns:

array of IDocumentContainer

getDocumentContainersWithCategory

java.util.List<? extends IDocumentContainer> getDocumentContainersWithCategory(java.lang.String categoryID,
                                                                               java.lang.String sortingProperty)

Returns all contained document containers that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - the sorting property

Returns:

array of IDocumentContainer

getDocumentContainersWithDefaultCategory

java.util.List<? extends IDocumentContainer> getDocumentContainersWithDefaultCategory()

Returns all contained document containers that belong to the default category.

The document containers are sorted by natural order.

Returns:

array of IDocumentContainer

getDocumentContainersWithDefaultCategory

java.util.List<? extends IDocumentContainer> getDocumentContainersWithDefaultCategory(java.lang.String sortingProperty)

Returns all contained document containers that belong to the default category.

Parameters:

sortingProperty - the sorting property

Returns:

array of IDocumentContainer

getCategoryID

java.lang.String getCategoryID()

toRecord

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

Converts this generic module data into a record.

In addition to all fields documented at ICockpitData.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

Returns:

converted cockpit project data