com.arcway.cockpit.docgen.provider.interfaces

Interface ICustomPropertiesAccess

All Superinterfaces:

ICockpitData

All Known Subinterfaces:

IFolder, IGraphic, IModelElement, IPlan, IProject, IStakeholder, IStakeholderRole

public interface ICustomPropertiesAccess
extends ICockpitData

This interface allows to access values of custom properties of an object. It is the base interface implemented by all objects supporting custom properties.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategoryID() Returns the ID of the category that the object belongs to.
java.lang.String	getCategoryLabel() Returns the label of the category that the object belongs to.
java.lang.Long	getDateTimeProperty_MilliSecondsSince_01_01_1970(java.lang.String propertyID) Returns the date time in millisenconds since 1st January 1970.
java.lang.String	getFileProperty(java.lang.String propertyID) Returns a XML DocBook representation to access the file attribute.
java.lang.String	getFileProperty(java.lang.String propertyID, double width_mm, double height_mm) Returns a XML DocBook representation to access the file attribute.
java.util.List<java.lang.String>	getFilePropertyAsBase64StringList(java.lang.String propertyID, boolean breakLines) Returns the content of a file as string list (Base64 encoded).
java.lang.String	getFilePropertyAsFileName(java.lang.String propertyID) Returns the local file name for a file attribute.
java.lang.String	getFilePropertyAsFileName(java.lang.String propertyID, java.lang.String fileNamePrefix) Returns the local file name for a file attribute.
java.util.List<java.lang.String>	getFilePropertyAsRawStringList(java.lang.String propertyID, java.lang.String characterEncoding) Returns the content of a file as string list.
java.util.List<java.lang.String>	getFilePropertyAsStringList(java.lang.String propertyID, java.lang.String characterEncoding) Returns the content of a file as string list (html encoded).
java.lang.String	getPropertyAsString(java.lang.String propertyID) Returns a string representation of the property value.
java.util.List<java.lang.String>	getPropertyAsStringArray(java.lang.String propertyID) Deprecated. use getPropertyAsStringList(String)
java.util.List<java.lang.String>	getPropertyAsStringList(java.lang.String propertyID) Returns a list of strings representing the property value.
boolean	hasCustomPropertyValues() Checks whether this object has any custom properties with values.
boolean	hasDefaultCategory() Returns whether the object belongs to the default category or not.
boolean	hasPropertyValue(java.lang.String propertyID) Checks whether the object has a property with specified ID for which a value is set.
IImageInfo	readImageInfoOfFileProperty(java.lang.String propertyID) Returns meta information regarding an image file stored in a custom propery.
IRecord	toRecord() Converts this cockpit project 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, getLinkForShow, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, getUniqueIdentifier, toRecord

Method Detail

hasCustomPropertyValues

boolean hasCustomPropertyValues()

Checks whether this object has any custom properties with values.

Returns:

true: this object has custom properties with values

hasPropertyValue

boolean hasPropertyValue(java.lang.String propertyID)

Checks whether the object has a property with specified ID for which a value is set. The id of a property always starts with custom. followed by a name/ID which can be defined when specifying the custom properties of a project.

Parameters:

propertyID - The properties id

Returns:

true: the object has a property with the specified ID and this property has a value

getPropertyAsString

java.lang.String getPropertyAsString(java.lang.String propertyID)

Returns a string representation of the property value. The string is HTML encoded and can be inserted into the template without further transformation.
E.g.:

• a boolean property will return one of 'true' or 'false' in project language
• a date property will return the date formatted in project language
• a file property will, for example, create an embedded object in word reports or a hyperlink to the file in html reports, if the file is an image the image will be displayed.

Parameters:

propertyID - The properties id

Returns:

String representation of the property

getPropertyAsStringArray

@Deprecated
java.util.List<java.lang.String> getPropertyAsStringArray(java.lang.String propertyID)

Deprecated. use getPropertyAsStringList(String)

Returns an array of strings representing the property value. The strings are already HTML encoded and can be inserted into document file without further transformation. This method shall be used instead of getPropertyAsString() when the text may contain carriage return or line breaks and shall be splitted into several string objects.

Parameters:

propertyID - IThe properties id

Returns:

String representations of the property

getPropertyAsStringList

java.util.List<java.lang.String> getPropertyAsStringList(java.lang.String propertyID)

Returns a list of strings representing the property value. The strings are already HTML encoded and can be inserted into document file without further transformation. This method shall be used instead of getPropertyAsString() when the text may contain carriage return or line breaks and shall be splitted into several string objects.

Parameters:

propertyID - The properties id

Returns:

String representations of the property

getFileProperty

java.lang.String getFileProperty(java.lang.String propertyID)

Returns a XML DocBook representation to access the file attribute. The file atttribute is loaded from the server and stored in a temporary directory. The XML DocBook representation depends on the currently selected document writer which will transform the transitional format into the selected target format.

Parameters:

propertyID - The properties id

Returns:

XML DocBook representation

getFileProperty

java.lang.String getFileProperty(java.lang.String propertyID,
                                 double width_mm,
                                 double height_mm)

Returns a XML DocBook representation to access the file attribute. The file atttribute is loaded from the server and stored in a temporary directory. The XML DocBook representation depends on the currently selected document writer which will transform the transitional format into the selected target format. If the file represents an image, width and height can be specified (0 = unspecified)

Parameters:

propertyID - The properties id

width_mm - width in mm (0 = unspecified)

height_mm - height in mm (0 = unspecified)

Returns:

XML DocBook representation

getFilePropertyAsFileName

java.lang.String getFilePropertyAsFileName(java.lang.String propertyID)

Returns the local file name for a file attribute. The file atttribute is loaded from the server and stored in a temporary directory. The file can be accessed during document generation. It will not be available anymore from the target output.

Parameters:

propertyID - The properties id

Returns:

absolute path name of the file

getFilePropertyAsFileName

java.lang.String getFilePropertyAsFileName(java.lang.String propertyID,
                                           java.lang.String fileNamePrefix)

Returns the local file name for a file attribute. The file atttribute is loaded from the server and stored in a temporary directory. The file can be accessed during document generation. It will not be available anymore from the target output.

Parameters:

propertyID - The properties id

fileNamePrefix - prefix that is added to the file name

Returns:

absolute path name of the file

getFilePropertyAsStringList

java.util.List<java.lang.String> getFilePropertyAsStringList(java.lang.String propertyID,
                                                             java.lang.String characterEncoding)

Returns the content of a file as string list (html encoded).

Parameters:

propertyID - The properties id

characterEncoding - the encoding to be used when reading the file

Returns:

the file content (HTML encoded, empty for no file)

getFilePropertyAsRawStringList

java.util.List<java.lang.String> getFilePropertyAsRawStringList(java.lang.String propertyID,
                                                                java.lang.String characterEncoding)

Returns the content of a file as string list.

Parameters:

propertyID - The properties id

characterEncoding - the encoding to be used when reading the file

Returns:

the file content (NOT HTML encoded, empty for no file)

getFilePropertyAsBase64StringList

java.util.List<java.lang.String> getFilePropertyAsBase64StringList(java.lang.String propertyID,
                                                                   boolean breakLines)

Returns the content of a file as string list (Base64 encoded).

Parameters:

propertyID - The properties id

breakLines - true to add line breaks

Returns:

the file content (Base64 encoded, empty for no file)

readImageInfoOfFileProperty

IImageInfo readImageInfoOfFileProperty(java.lang.String propertyID)

Returns meta information regarding an image file stored in a custom propery.

Parameters:

propertyID - The properties id

imagefileName - the image file name

Returns:

image info (null for no file)

getDateTimeProperty_MilliSecondsSince_01_01_1970

java.lang.Long getDateTimeProperty_MilliSecondsSince_01_01_1970(java.lang.String propertyID)

Returns the date time in millisenconds since 1st January 1970. If no value ist set or any paramaters are invalid, the method returns null.

Parameters:

propertyID - The properties id

Returns:

millisenconds since 1st January 1970 or null, if no date time ist set or any parameter is invalid

getCategoryID

java.lang.String getCategoryID()

Returns the ID of the category that the object belongs to.

Returns:

the ID of the category that the object belongs to

getCategoryLabel

java.lang.String getCategoryLabel()

Returns the label of the category that the object belongs to.

Returns:

the label of the category that the object belongs to.

hasDefaultCategory

boolean hasDefaultCategory()

Returns whether the object belongs to the default category or not.

Returns:

true, if the object belongs to the default category, otherwise false

toRecord

IRecord toRecord()

Converts this cockpit project 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.CATEGORY_ID_KEY
• all fields starting with IRecord.CUSTOM_KEY_PREFIX
  • text or multiple choice properties: IRecord.getAll(String) will return the value as list of strings
  • date properties: IRecord.get(String) will return a decimal string representing the miliseconds since 1970-01-01
  • file properties: IRecord.getAll(String) will return the file content as base64 encoded strings, IRecord.get(String) with key "propertyID" + IRecord.FILE_NAME_POSTFIX will return the file name
  • other properties: IRecord.get(String) will return the value als string

Concrete types may fill in further fields (see there).

Specified by:

toRecord in interface ICockpitData

Returns:

converted cockpit project data