com.arcway.cockpit.usecasemodule.docgen.provider.interfaces

Interface IUseCaseCategory

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 IUseCaseCategory
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

The IUseCaseCategory object allows to read attribute values of a use case category from the COCKPIT use case module. Starting with this object, you can get references to the use cases of the category.

Item type constant: "ucm.useCaseSet"

Method Summary

Modifier and Type	Method and Description
boolean	containsUseCases() Checks whether the category contains any use cases.
java.lang.String	getName() Returns the name of the category.
java.lang.String	getUniqueIdentifier() Returns a unique identifier that uniquely identifies this object within its project.
java.util.List<? extends IUseCase>	getUseCases() Returns all use cases of the category.
java.util.List<? extends IUseCase>	getUseCases(int sortingCriterion) Returns all use cases of the category.
java.util.List<? extends IUseCase>	getUseCases(java.lang.String sortingProperty) Returns all use cases of the category.
java.util.List<? extends IUseCase>	getUseCasesWithCategory(java.lang.String categoryID) Returns all use cases of the category that belongs to the specified category.
java.util.List<? extends IUseCase>	getUseCasesWithCategory(java.lang.String categoryID, int sortingCriterion) Returns all use cases of the category that belongs to the specified category.
java.util.List<? extends IUseCase>	getUseCasesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns all use cases of the category that belongs to the specified category.
java.util.List<? extends IUseCase>	getUseCasesWithDefaultCategory() Returns all use cases of the category that belongs to the default category.
java.util.List<? extends IUseCase>	getUseCasesWithDefaultCategory(int sortingCriterion) Returns all use cases of the category that belongs to the default category.
java.util.List<? extends IUseCase>	getUseCasesWithDefaultCategory(java.lang.String sortingProperty) Returns all use cases of the category that belongs 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:

unique identifier

getName

java.lang.String getName()

Returns the name of the category.

Returns:

name (never null) (may be null)

containsUseCases

boolean containsUseCases()

Checks whether the category contains any use cases.

Returns:

true, if the category contains use cases, false otherwise

getUseCases

java.util.List<? extends IUseCase> getUseCases()

Returns all use cases of the category.

The use cases are sorted by id.

Returns:

array containing the use cases (!=null)

getUseCasesWithCategory

java.util.List<? extends IUseCase> getUseCasesWithCategory(java.lang.String categoryID)

Returns all use cases of the category that belongs to the specified category.

The use cases are sorted by id.

Parameters:

categoryID - the categoryID

Returns:

array containing the use cases (!=null)

getUseCasesWithDefaultCategory

java.util.List<? extends IUseCase> getUseCasesWithDefaultCategory()

Returns all use cases of the category that belongs to the default category.

The use cases are sorted by id.

Returns:

array containing the use cases (!=null)

getUseCases

java.util.List<? extends IUseCase> getUseCases(int sortingCriterion)

Returns all use cases of the category.

Parameters:

sortingCriterion - specifies the criterion for sorting. Use the integer constants in IUseCaseDataProvider.

Returns:

array containing the use cases (!= null)

getUseCasesWithCategory

java.util.List<? extends IUseCase> getUseCasesWithCategory(java.lang.String categoryID,
                                                           int sortingCriterion)

Returns all use cases of the category that belongs to the specified category.

Parameters:

categoryID - the categoryID

sortingCriterion - specifies the criterion for sorting. Use the integer constants in IUseCaseDataProvider.

Returns:

array containing the use cases (!= null)

getUseCasesWithDefaultCategory

java.util.List<? extends IUseCase> getUseCasesWithDefaultCategory(int sortingCriterion)

Returns all use cases of the category that belongs to the default category.

Parameters:

sortingCriterion - specifies the criterion for sorting. Use the integer constants in IUseCaseDataProvider.

Returns:

array containing the use cases (!= null)

getUseCases

java.util.List<? extends IUseCase> getUseCases(java.lang.String sortingProperty)

Returns all use cases of the category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting.

Returns:

array containing the use cases (!= null)

getUseCasesWithCategory

java.util.List<? extends IUseCase> getUseCasesWithCategory(java.lang.String categoryID,
                                                           java.lang.String sortingProperty)

Returns all use cases of the category that belongs to the specified category.

Parameters:

categoryID - the categoryID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting.

Returns:

array containing the use cases (!= null)

getUseCasesWithDefaultCategory

java.util.List<? extends IUseCase> getUseCasesWithDefaultCategory(java.lang.String sortingProperty)

Returns all use cases of the category that belongs to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting.

Returns:

array containing the use cases (!= null)

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